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.
17 use chain::channelmonitor;
18 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
19 use chain::transaction::OutPoint;
20 use chain::keysinterface::{KeysInterface, BaseSign};
21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
23 use ln::channel::{Channel, ChannelError};
24 use ln::{chan_utils, onion_utils};
25 use routing::router::{Route, RouteHop, get_route};
26 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
28 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
29 use util::enforcing_trait_impls::EnforcingSigner;
30 use util::{byte_utils, test_utils};
31 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
32 use util::errors::APIError;
33 use util::ser::{Writeable, ReadableArgs};
34 use util::config::UserConfig;
36 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
37 use bitcoin::hash_types::{Txid, BlockHash};
38 use bitcoin::blockdata::block::{Block, BlockHeader};
39 use bitcoin::blockdata::script::Builder;
40 use bitcoin::blockdata::opcodes;
41 use bitcoin::blockdata::constants::genesis_block;
42 use bitcoin::network::constants::Network;
44 use bitcoin::hashes::sha256::Hash as Sha256;
45 use bitcoin::hashes::Hash;
47 use bitcoin::secp256k1::{Secp256k1, Message};
48 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
52 use std::collections::{BTreeSet, HashMap, HashSet};
53 use std::default::Default;
56 use ln::functional_test_utils::*;
57 use ln::chan_utils::CommitmentTransaction;
58 use ln::msgs::OptionalField::Present;
61 fn test_insane_channel_opens() {
62 // Stand up a network of 2 nodes
63 let chanmon_cfgs = create_chanmon_cfgs(2);
64 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
65 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
66 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
68 // Instantiate channel parameters where we push the maximum msats given our
70 let channel_value_sat = 31337; // same as funding satoshis
71 let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
72 let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
74 // Have node0 initiate a channel to node1 with aforementioned parameters
75 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
77 // Extract the channel open message from node0 to node1
78 let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
80 // Test helper that asserts we get the correct error string given a mutator
81 // that supposedly makes the channel open message insane
82 let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
83 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
84 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
85 assert_eq!(msg_events.len(), 1);
86 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
87 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
89 &ErrorAction::SendErrorMessage { .. } => {
90 nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
92 _ => panic!("unexpected event!"),
94 } else { assert!(false); }
97 use ln::channel::MAX_FUNDING_SATOSHIS;
98 use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
100 // Test all mutations that would make the channel open message insane
101 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 });
103 insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
105 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 });
107 insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
109 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 });
111 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 });
113 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 });
115 insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
117 insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
121 fn test_async_inbound_update_fee() {
122 let chanmon_cfgs = create_chanmon_cfgs(2);
123 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
124 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
125 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
126 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
127 let logger = test_utils::TestLogger::new();
128 let channel_id = chan.2;
131 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
135 // send (1) commitment_signed -.
136 // <- update_add_htlc/commitment_signed
137 // send (2) RAA (awaiting remote revoke) -.
138 // (1) commitment_signed is delivered ->
139 // .- send (3) RAA (awaiting remote revoke)
140 // (2) RAA is delivered ->
141 // .- send (4) commitment_signed
142 // <- (3) RAA is delivered
143 // send (5) commitment_signed -.
144 // <- (4) commitment_signed is delivered
146 // (5) commitment_signed is delivered ->
148 // (6) RAA is delivered ->
150 // First nodes[0] generates an update_fee
151 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
152 check_added_monitors!(nodes[0], 1);
154 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
155 assert_eq!(events_0.len(), 1);
156 let (update_msg, commitment_signed) = match events_0[0] { // (1)
157 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
158 (update_fee.as_ref(), commitment_signed)
160 _ => panic!("Unexpected event"),
163 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
165 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
166 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
167 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
168 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
169 check_added_monitors!(nodes[1], 1);
171 let payment_event = {
172 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
173 assert_eq!(events_1.len(), 1);
174 SendEvent::from_event(events_1.remove(0))
176 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
177 assert_eq!(payment_event.msgs.len(), 1);
179 // ...now when the messages get delivered everyone should be happy
180 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
181 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
182 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
183 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
184 check_added_monitors!(nodes[0], 1);
186 // deliver(1), generate (3):
187 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
188 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
189 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
190 check_added_monitors!(nodes[1], 1);
192 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
193 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
194 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
195 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
196 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
197 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
198 assert!(bs_update.update_fee.is_none()); // (4)
199 check_added_monitors!(nodes[1], 1);
201 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
202 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
203 assert!(as_update.update_add_htlcs.is_empty()); // (5)
204 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
205 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
206 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
207 assert!(as_update.update_fee.is_none()); // (5)
208 check_added_monitors!(nodes[0], 1);
210 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
211 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
212 // only (6) so get_event_msg's assert(len == 1) passes
213 check_added_monitors!(nodes[0], 1);
215 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
216 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
217 check_added_monitors!(nodes[1], 1);
219 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
220 check_added_monitors!(nodes[0], 1);
222 let events_2 = nodes[0].node.get_and_clear_pending_events();
223 assert_eq!(events_2.len(), 1);
225 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
226 _ => panic!("Unexpected event"),
229 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
230 check_added_monitors!(nodes[1], 1);
234 fn test_update_fee_unordered_raa() {
235 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
236 // crash in an earlier version of the update_fee patch)
237 let chanmon_cfgs = create_chanmon_cfgs(2);
238 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
239 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
240 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
241 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
242 let channel_id = chan.2;
243 let logger = test_utils::TestLogger::new();
246 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
248 // First nodes[0] generates an update_fee
249 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
250 check_added_monitors!(nodes[0], 1);
252 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
253 assert_eq!(events_0.len(), 1);
254 let update_msg = match events_0[0] { // (1)
255 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
258 _ => panic!("Unexpected event"),
261 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
263 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
264 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
265 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
266 nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
267 check_added_monitors!(nodes[1], 1);
269 let payment_event = {
270 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
271 assert_eq!(events_1.len(), 1);
272 SendEvent::from_event(events_1.remove(0))
274 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
275 assert_eq!(payment_event.msgs.len(), 1);
277 // ...now when the messages get delivered everyone should be happy
278 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
279 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
280 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
281 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
282 check_added_monitors!(nodes[0], 1);
284 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
285 check_added_monitors!(nodes[1], 1);
287 // We can't continue, sadly, because our (1) now has a bogus signature
291 fn test_multi_flight_update_fee() {
292 let chanmon_cfgs = create_chanmon_cfgs(2);
293 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
294 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
295 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
296 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
297 let channel_id = chan.2;
300 // update_fee/commitment_signed ->
301 // .- send (1) RAA and (2) commitment_signed
302 // update_fee (never committed) ->
304 // We have to manually generate the above update_fee, it is allowed by the protocol but we
305 // don't track which updates correspond to which revoke_and_ack responses so we're in
306 // AwaitingRAA mode and will not generate the update_fee yet.
307 // <- (1) RAA delivered
308 // (3) is generated and send (4) CS -.
309 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
310 // know the per_commitment_point to use for it.
311 // <- (2) commitment_signed delivered
313 // B should send no response here
314 // (4) commitment_signed delivered ->
315 // <- RAA/commitment_signed delivered
318 // First nodes[0] generates an update_fee
319 let initial_feerate = get_feerate!(nodes[0], channel_id);
320 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
321 check_added_monitors!(nodes[0], 1);
323 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
324 assert_eq!(events_0.len(), 1);
325 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
326 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
327 (update_fee.as_ref().unwrap(), commitment_signed)
329 _ => panic!("Unexpected event"),
332 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
333 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
334 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
335 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
336 check_added_monitors!(nodes[1], 1);
338 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
340 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
341 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
342 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
344 // Create the (3) update_fee message that nodes[0] will generate before it does...
345 let mut update_msg_2 = msgs::UpdateFee {
346 channel_id: update_msg_1.channel_id.clone(),
347 feerate_per_kw: (initial_feerate + 30) as u32,
350 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
352 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
354 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
356 // Deliver (1), generating (3) and (4)
357 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
358 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
359 check_added_monitors!(nodes[0], 1);
360 assert!(as_second_update.update_add_htlcs.is_empty());
361 assert!(as_second_update.update_fulfill_htlcs.is_empty());
362 assert!(as_second_update.update_fail_htlcs.is_empty());
363 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
364 // Check that the update_fee newly generated matches what we delivered:
365 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
366 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
368 // Deliver (2) commitment_signed
369 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
370 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
371 check_added_monitors!(nodes[0], 1);
372 // No commitment_signed so get_event_msg's assert(len == 1) passes
374 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
375 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
376 check_added_monitors!(nodes[1], 1);
379 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
380 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
381 check_added_monitors!(nodes[1], 1);
383 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
384 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
385 check_added_monitors!(nodes[0], 1);
387 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
388 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
389 // No commitment_signed so get_event_msg's assert(len == 1) passes
390 check_added_monitors!(nodes[0], 1);
392 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
393 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
394 check_added_monitors!(nodes[1], 1);
397 fn do_test_1_conf_open(connect_style: ConnectStyle) {
398 // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
399 // tests that we properly send one in that case.
400 let mut alice_config = UserConfig::default();
401 alice_config.own_channel_config.minimum_depth = 1;
402 alice_config.channel_options.announced_channel = true;
403 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
404 let mut bob_config = UserConfig::default();
405 bob_config.own_channel_config.minimum_depth = 1;
406 bob_config.channel_options.announced_channel = true;
407 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
408 let chanmon_cfgs = create_chanmon_cfgs(2);
409 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
410 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
411 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
412 *nodes[0].connect_style.borrow_mut() = connect_style;
414 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
415 mine_transaction(&nodes[1], &tx);
416 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()));
418 mine_transaction(&nodes[0], &tx);
419 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
420 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
423 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
424 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
425 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
429 fn test_1_conf_open() {
430 do_test_1_conf_open(ConnectStyle::BestBlockFirst);
431 do_test_1_conf_open(ConnectStyle::TransactionsFirst);
432 do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
435 fn do_test_sanity_on_in_flight_opens(steps: u8) {
436 // Previously, we had issues deserializing channels when we hadn't connected the first block
437 // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
438 // serialization round-trips and simply do steps towards opening a channel and then drop the
441 let chanmon_cfgs = create_chanmon_cfgs(2);
442 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
443 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
444 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
446 if steps & 0b1000_0000 != 0{
448 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
451 connect_block(&nodes[0], &block);
452 connect_block(&nodes[1], &block);
455 if steps & 0x0f == 0 { return; }
456 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
457 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
459 if steps & 0x0f == 1 { return; }
460 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
461 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
463 if steps & 0x0f == 2 { return; }
464 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
466 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
468 if steps & 0x0f == 3 { return; }
469 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
470 check_added_monitors!(nodes[0], 0);
471 let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
473 if steps & 0x0f == 4 { return; }
474 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
476 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
477 assert_eq!(added_monitors.len(), 1);
478 assert_eq!(added_monitors[0].0, funding_output);
479 added_monitors.clear();
481 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
483 if steps & 0x0f == 5 { return; }
484 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
486 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
487 assert_eq!(added_monitors.len(), 1);
488 assert_eq!(added_monitors[0].0, funding_output);
489 added_monitors.clear();
492 let events_4 = nodes[0].node.get_and_clear_pending_events();
493 assert_eq!(events_4.len(), 0);
495 if steps & 0x0f == 6 { return; }
496 create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
498 if steps & 0x0f == 7 { return; }
499 confirm_transaction_at(&nodes[0], &tx, 2);
500 connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
501 create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
505 fn test_sanity_on_in_flight_opens() {
506 do_test_sanity_on_in_flight_opens(0);
507 do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
508 do_test_sanity_on_in_flight_opens(1);
509 do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
510 do_test_sanity_on_in_flight_opens(2);
511 do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
512 do_test_sanity_on_in_flight_opens(3);
513 do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
514 do_test_sanity_on_in_flight_opens(4);
515 do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
516 do_test_sanity_on_in_flight_opens(5);
517 do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
518 do_test_sanity_on_in_flight_opens(6);
519 do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
520 do_test_sanity_on_in_flight_opens(7);
521 do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
522 do_test_sanity_on_in_flight_opens(8);
523 do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
527 fn test_update_fee_vanilla() {
528 let chanmon_cfgs = create_chanmon_cfgs(2);
529 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
530 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
531 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
532 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
533 let channel_id = chan.2;
535 let feerate = get_feerate!(nodes[0], channel_id);
536 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
537 check_added_monitors!(nodes[0], 1);
539 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
540 assert_eq!(events_0.len(), 1);
541 let (update_msg, commitment_signed) = match events_0[0] {
542 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 } } => {
543 (update_fee.as_ref(), commitment_signed)
545 _ => panic!("Unexpected event"),
547 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
549 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
550 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
551 check_added_monitors!(nodes[1], 1);
553 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
554 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
555 check_added_monitors!(nodes[0], 1);
557 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
558 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
559 // No commitment_signed so get_event_msg's assert(len == 1) passes
560 check_added_monitors!(nodes[0], 1);
562 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
563 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
564 check_added_monitors!(nodes[1], 1);
568 fn test_update_fee_that_funder_cannot_afford() {
569 let chanmon_cfgs = create_chanmon_cfgs(2);
570 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
571 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
572 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
573 let channel_value = 1888;
574 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
575 let channel_id = chan.2;
578 nodes[0].node.update_fee(channel_id, feerate).unwrap();
579 check_added_monitors!(nodes[0], 1);
580 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
582 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
584 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
586 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
587 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
589 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
591 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
592 let num_htlcs = commitment_tx.output.len() - 2;
593 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
594 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
595 actual_fee = channel_value - actual_fee;
596 assert_eq!(total_fee, actual_fee);
599 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
600 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
601 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
602 check_added_monitors!(nodes[0], 1);
604 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
606 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
608 //While producing the commitment_signed response after handling a received update_fee request the
609 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
610 //Should produce and error.
611 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
612 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
613 check_added_monitors!(nodes[1], 1);
614 check_closed_broadcast!(nodes[1], true);
618 fn test_update_fee_with_fundee_update_add_htlc() {
619 let chanmon_cfgs = create_chanmon_cfgs(2);
620 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
621 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
622 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
623 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
624 let channel_id = chan.2;
625 let logger = test_utils::TestLogger::new();
628 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
630 let feerate = get_feerate!(nodes[0], channel_id);
631 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
632 check_added_monitors!(nodes[0], 1);
634 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
635 assert_eq!(events_0.len(), 1);
636 let (update_msg, commitment_signed) = match events_0[0] {
637 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 } } => {
638 (update_fee.as_ref(), commitment_signed)
640 _ => panic!("Unexpected event"),
642 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
643 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
644 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
645 check_added_monitors!(nodes[1], 1);
647 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
648 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
649 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
651 // nothing happens since node[1] is in AwaitingRemoteRevoke
652 nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
654 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
655 assert_eq!(added_monitors.len(), 0);
656 added_monitors.clear();
658 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
659 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
660 // node[1] has nothing to do
662 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
663 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
664 check_added_monitors!(nodes[0], 1);
666 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
667 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
668 // No commitment_signed so get_event_msg's assert(len == 1) passes
669 check_added_monitors!(nodes[0], 1);
670 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
671 check_added_monitors!(nodes[1], 1);
672 // AwaitingRemoteRevoke ends here
674 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
675 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
676 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
677 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
678 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
679 assert_eq!(commitment_update.update_fee.is_none(), true);
681 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
682 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
683 check_added_monitors!(nodes[0], 1);
684 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
686 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
687 check_added_monitors!(nodes[1], 1);
688 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
690 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
691 check_added_monitors!(nodes[1], 1);
692 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
693 // No commitment_signed so get_event_msg's assert(len == 1) passes
695 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
696 check_added_monitors!(nodes[0], 1);
697 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
699 expect_pending_htlcs_forwardable!(nodes[0]);
701 let events = nodes[0].node.get_and_clear_pending_events();
702 assert_eq!(events.len(), 1);
704 Event::PaymentReceived { .. } => { },
705 _ => panic!("Unexpected event"),
708 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
710 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
711 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
712 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
716 fn test_update_fee() {
717 let chanmon_cfgs = create_chanmon_cfgs(2);
718 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
719 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
720 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
721 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
722 let channel_id = chan.2;
725 // (1) update_fee/commitment_signed ->
726 // <- (2) revoke_and_ack
727 // .- send (3) commitment_signed
728 // (4) update_fee/commitment_signed ->
729 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
730 // <- (3) commitment_signed delivered
731 // send (6) revoke_and_ack -.
732 // <- (5) deliver revoke_and_ack
733 // (6) deliver revoke_and_ack ->
734 // .- send (7) commitment_signed in response to (4)
735 // <- (7) deliver commitment_signed
738 // Create and deliver (1)...
739 let feerate = get_feerate!(nodes[0], channel_id);
740 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
741 check_added_monitors!(nodes[0], 1);
743 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
744 assert_eq!(events_0.len(), 1);
745 let (update_msg, commitment_signed) = match events_0[0] {
746 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 } } => {
747 (update_fee.as_ref(), commitment_signed)
749 _ => panic!("Unexpected event"),
751 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
753 // Generate (2) and (3):
754 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
755 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
756 check_added_monitors!(nodes[1], 1);
759 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
760 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
761 check_added_monitors!(nodes[0], 1);
763 // Create and deliver (4)...
764 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
765 check_added_monitors!(nodes[0], 1);
766 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
767 assert_eq!(events_0.len(), 1);
768 let (update_msg, commitment_signed) = match events_0[0] {
769 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 } } => {
770 (update_fee.as_ref(), commitment_signed)
772 _ => panic!("Unexpected event"),
775 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
776 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
777 check_added_monitors!(nodes[1], 1);
779 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
780 // No commitment_signed so get_event_msg's assert(len == 1) passes
782 // Handle (3), creating (6):
783 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
784 check_added_monitors!(nodes[0], 1);
785 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
786 // No commitment_signed so get_event_msg's assert(len == 1) passes
789 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
790 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
791 check_added_monitors!(nodes[0], 1);
793 // Deliver (6), creating (7):
794 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
795 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
796 assert!(commitment_update.update_add_htlcs.is_empty());
797 assert!(commitment_update.update_fulfill_htlcs.is_empty());
798 assert!(commitment_update.update_fail_htlcs.is_empty());
799 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
800 assert!(commitment_update.update_fee.is_none());
801 check_added_monitors!(nodes[1], 1);
804 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
805 check_added_monitors!(nodes[0], 1);
806 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
807 // No commitment_signed so get_event_msg's assert(len == 1) passes
809 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
810 check_added_monitors!(nodes[1], 1);
811 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
813 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
814 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
815 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
819 fn pre_funding_lock_shutdown_test() {
820 // Test sending a shutdown prior to funding_locked after funding generation
821 let chanmon_cfgs = create_chanmon_cfgs(2);
822 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
823 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
824 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
825 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
826 mine_transaction(&nodes[0], &tx);
827 mine_transaction(&nodes[1], &tx);
829 nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
830 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
831 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
832 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
833 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
835 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
836 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
837 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
838 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
839 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
840 assert!(node_0_none.is_none());
842 assert!(nodes[0].node.list_channels().is_empty());
843 assert!(nodes[1].node.list_channels().is_empty());
847 fn updates_shutdown_wait() {
848 // Test sending a shutdown with outstanding updates pending
849 let chanmon_cfgs = create_chanmon_cfgs(3);
850 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
851 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
852 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
853 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
854 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
855 let logger = test_utils::TestLogger::new();
857 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
859 nodes[0].node.close_channel(&chan_1.2).unwrap();
860 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
861 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
862 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
863 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
865 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
866 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
868 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
870 let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
871 let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
872 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
873 let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
874 unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
875 unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
877 assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
878 check_added_monitors!(nodes[2], 1);
879 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
880 assert!(updates.update_add_htlcs.is_empty());
881 assert!(updates.update_fail_htlcs.is_empty());
882 assert!(updates.update_fail_malformed_htlcs.is_empty());
883 assert!(updates.update_fee.is_none());
884 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
885 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
886 check_added_monitors!(nodes[1], 1);
887 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
888 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
890 assert!(updates_2.update_add_htlcs.is_empty());
891 assert!(updates_2.update_fail_htlcs.is_empty());
892 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
893 assert!(updates_2.update_fee.is_none());
894 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
895 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
896 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
898 let events = nodes[0].node.get_and_clear_pending_events();
899 assert_eq!(events.len(), 1);
901 Event::PaymentSent { ref payment_preimage } => {
902 assert_eq!(our_payment_preimage, *payment_preimage);
904 _ => panic!("Unexpected event"),
907 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
908 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
909 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
910 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
911 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
912 assert!(node_0_none.is_none());
914 assert!(nodes[0].node.list_channels().is_empty());
916 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
917 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
918 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
919 assert!(nodes[1].node.list_channels().is_empty());
920 assert!(nodes[2].node.list_channels().is_empty());
924 fn htlc_fail_async_shutdown() {
925 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
926 let chanmon_cfgs = create_chanmon_cfgs(3);
927 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
928 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
929 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
930 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
931 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
932 let logger = test_utils::TestLogger::new();
934 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
935 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
936 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
937 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
938 check_added_monitors!(nodes[0], 1);
939 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
940 assert_eq!(updates.update_add_htlcs.len(), 1);
941 assert!(updates.update_fulfill_htlcs.is_empty());
942 assert!(updates.update_fail_htlcs.is_empty());
943 assert!(updates.update_fail_malformed_htlcs.is_empty());
944 assert!(updates.update_fee.is_none());
946 nodes[1].node.close_channel(&chan_1.2).unwrap();
947 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
948 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
949 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
951 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
952 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
953 check_added_monitors!(nodes[1], 1);
954 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
955 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
957 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
958 assert!(updates_2.update_add_htlcs.is_empty());
959 assert!(updates_2.update_fulfill_htlcs.is_empty());
960 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
961 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
962 assert!(updates_2.update_fee.is_none());
964 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
965 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
967 expect_payment_failed!(nodes[0], our_payment_hash, false);
969 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
970 assert_eq!(msg_events.len(), 2);
971 let node_0_closing_signed = match msg_events[0] {
972 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
973 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
976 _ => panic!("Unexpected event"),
978 match msg_events[1] {
979 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
980 assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
982 _ => panic!("Unexpected event"),
985 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
986 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
987 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
988 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
989 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
990 assert!(node_0_none.is_none());
992 assert!(nodes[0].node.list_channels().is_empty());
994 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
995 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
996 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
997 assert!(nodes[1].node.list_channels().is_empty());
998 assert!(nodes[2].node.list_channels().is_empty());
1001 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1002 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1003 // messages delivered prior to disconnect
1004 let chanmon_cfgs = create_chanmon_cfgs(3);
1005 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1006 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1007 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1008 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1009 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1011 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1013 nodes[1].node.close_channel(&chan_1.2).unwrap();
1014 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1016 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1017 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1019 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1023 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1024 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1026 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1027 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1028 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1029 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1031 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1032 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1033 assert!(node_1_shutdown == node_1_2nd_shutdown);
1035 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1036 let node_0_2nd_shutdown = if recv_count > 0 {
1037 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1038 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1041 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1042 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1043 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1045 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1047 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1048 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1050 assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1051 check_added_monitors!(nodes[2], 1);
1052 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1053 assert!(updates.update_add_htlcs.is_empty());
1054 assert!(updates.update_fail_htlcs.is_empty());
1055 assert!(updates.update_fail_malformed_htlcs.is_empty());
1056 assert!(updates.update_fee.is_none());
1057 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1058 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1059 check_added_monitors!(nodes[1], 1);
1060 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1061 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1063 assert!(updates_2.update_add_htlcs.is_empty());
1064 assert!(updates_2.update_fail_htlcs.is_empty());
1065 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1066 assert!(updates_2.update_fee.is_none());
1067 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1068 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1069 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1071 let events = nodes[0].node.get_and_clear_pending_events();
1072 assert_eq!(events.len(), 1);
1074 Event::PaymentSent { ref payment_preimage } => {
1075 assert_eq!(our_payment_preimage, *payment_preimage);
1077 _ => panic!("Unexpected event"),
1080 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1082 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1083 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1084 assert!(node_1_closing_signed.is_some());
1087 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1088 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1090 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1091 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1092 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1093 if recv_count == 0 {
1094 // If all closing_signeds weren't delivered we can just resume where we left off...
1095 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1097 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1098 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1099 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1101 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1102 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1103 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1105 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1106 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1108 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1109 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1110 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1112 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1113 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1114 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1115 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1116 assert!(node_0_none.is_none());
1118 // If one node, however, received + responded with an identical closing_signed we end
1119 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1120 // There isn't really anything better we can do simply, but in the future we might
1121 // explore storing a set of recently-closed channels that got disconnected during
1122 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1123 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1125 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1127 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1128 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1129 assert_eq!(msg_events.len(), 1);
1130 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1132 &ErrorAction::SendErrorMessage { ref msg } => {
1133 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1134 assert_eq!(msg.channel_id, chan_1.2);
1136 _ => panic!("Unexpected event!"),
1138 } else { panic!("Needed SendErrorMessage close"); }
1140 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1141 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1142 // closing_signed so we do it ourselves
1143 check_closed_broadcast!(nodes[0], false);
1144 check_added_monitors!(nodes[0], 1);
1147 assert!(nodes[0].node.list_channels().is_empty());
1149 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1150 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1151 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1152 assert!(nodes[1].node.list_channels().is_empty());
1153 assert!(nodes[2].node.list_channels().is_empty());
1157 fn test_shutdown_rebroadcast() {
1158 do_test_shutdown_rebroadcast(0);
1159 do_test_shutdown_rebroadcast(1);
1160 do_test_shutdown_rebroadcast(2);
1164 fn fake_network_test() {
1165 // Simple test which builds a network of ChannelManagers, connects them to each other, and
1166 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1167 let chanmon_cfgs = create_chanmon_cfgs(4);
1168 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1169 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1170 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1172 // Create some initial channels
1173 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1174 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1175 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1177 // Rebalance the network a bit by relaying one payment through all the channels...
1178 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1179 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1180 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1181 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1183 // Send some more payments
1184 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1185 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1186 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1188 // Test failure packets
1189 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1190 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1192 // Add a new channel that skips 3
1193 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1195 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1196 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1197 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1198 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1199 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1200 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1201 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1203 // Do some rebalance loop payments, simultaneously
1204 let mut hops = Vec::with_capacity(3);
1205 hops.push(RouteHop {
1206 pubkey: nodes[2].node.get_our_node_id(),
1207 node_features: NodeFeatures::empty(),
1208 short_channel_id: chan_2.0.contents.short_channel_id,
1209 channel_features: ChannelFeatures::empty(),
1211 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1213 hops.push(RouteHop {
1214 pubkey: nodes[3].node.get_our_node_id(),
1215 node_features: NodeFeatures::empty(),
1216 short_channel_id: chan_3.0.contents.short_channel_id,
1217 channel_features: ChannelFeatures::empty(),
1219 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1221 hops.push(RouteHop {
1222 pubkey: nodes[1].node.get_our_node_id(),
1223 node_features: NodeFeatures::empty(),
1224 short_channel_id: chan_4.0.contents.short_channel_id,
1225 channel_features: ChannelFeatures::empty(),
1227 cltv_expiry_delta: TEST_FINAL_CLTV,
1229 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;
1230 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;
1231 let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1233 let mut hops = Vec::with_capacity(3);
1234 hops.push(RouteHop {
1235 pubkey: nodes[3].node.get_our_node_id(),
1236 node_features: NodeFeatures::empty(),
1237 short_channel_id: chan_4.0.contents.short_channel_id,
1238 channel_features: ChannelFeatures::empty(),
1240 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1242 hops.push(RouteHop {
1243 pubkey: nodes[2].node.get_our_node_id(),
1244 node_features: NodeFeatures::empty(),
1245 short_channel_id: chan_3.0.contents.short_channel_id,
1246 channel_features: ChannelFeatures::empty(),
1248 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1250 hops.push(RouteHop {
1251 pubkey: nodes[1].node.get_our_node_id(),
1252 node_features: NodeFeatures::empty(),
1253 short_channel_id: chan_2.0.contents.short_channel_id,
1254 channel_features: ChannelFeatures::empty(),
1256 cltv_expiry_delta: TEST_FINAL_CLTV,
1258 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;
1259 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;
1260 let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1262 // Claim the rebalances...
1263 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1264 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1266 // Add a duplicate new channel from 2 to 4
1267 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1269 // Send some payments across both channels
1270 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1271 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1272 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1275 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1276 let events = nodes[0].node.get_and_clear_pending_msg_events();
1277 assert_eq!(events.len(), 0);
1278 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);
1280 //TODO: Test that routes work again here as we've been notified that the channel is full
1282 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1283 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1284 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1286 // Close down the channels...
1287 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1288 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1289 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1290 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1291 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1295 fn holding_cell_htlc_counting() {
1296 // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1297 // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1298 // commitment dance rounds.
1299 let chanmon_cfgs = create_chanmon_cfgs(3);
1300 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1301 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1302 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1303 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1304 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1305 let logger = test_utils::TestLogger::new();
1307 let mut payments = Vec::new();
1308 for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1309 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1310 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1311 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1312 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1313 payments.push((payment_preimage, payment_hash));
1315 check_added_monitors!(nodes[1], 1);
1317 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1318 assert_eq!(events.len(), 1);
1319 let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1320 assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1322 // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1323 // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1325 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1327 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1328 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1329 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1330 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1331 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1332 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1335 // This should also be true if we try to forward a payment.
1336 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1338 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1339 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1340 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1341 check_added_monitors!(nodes[0], 1);
1344 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1345 assert_eq!(events.len(), 1);
1346 let payment_event = SendEvent::from_event(events.pop().unwrap());
1347 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1349 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1350 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1351 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1352 // fails), the second will process the resulting failure and fail the HTLC backward.
1353 expect_pending_htlcs_forwardable!(nodes[1]);
1354 expect_pending_htlcs_forwardable!(nodes[1]);
1355 check_added_monitors!(nodes[1], 1);
1357 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1358 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1359 commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1361 let events = nodes[0].node.get_and_clear_pending_msg_events();
1362 assert_eq!(events.len(), 1);
1364 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1365 assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1367 _ => panic!("Unexpected event"),
1370 expect_payment_failed!(nodes[0], payment_hash_2, false);
1372 // Now forward all the pending HTLCs and claim them back
1373 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1374 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1375 check_added_monitors!(nodes[2], 1);
1377 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1378 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1379 check_added_monitors!(nodes[1], 1);
1380 let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1382 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1383 check_added_monitors!(nodes[1], 1);
1384 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1386 for ref update in as_updates.update_add_htlcs.iter() {
1387 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1389 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1390 check_added_monitors!(nodes[2], 1);
1391 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1392 check_added_monitors!(nodes[2], 1);
1393 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1395 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1396 check_added_monitors!(nodes[1], 1);
1397 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1398 check_added_monitors!(nodes[1], 1);
1399 let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1401 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1402 check_added_monitors!(nodes[2], 1);
1404 expect_pending_htlcs_forwardable!(nodes[2]);
1406 let events = nodes[2].node.get_and_clear_pending_events();
1407 assert_eq!(events.len(), payments.len());
1408 for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1410 &Event::PaymentReceived { ref payment_hash, .. } => {
1411 assert_eq!(*payment_hash, *hash);
1413 _ => panic!("Unexpected event"),
1417 for (preimage, _) in payments.drain(..) {
1418 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1421 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1425 fn duplicate_htlc_test() {
1426 // Test that we accept duplicate payment_hash HTLCs across the network and that
1427 // claiming/failing them are all separate and don't affect each other
1428 let chanmon_cfgs = create_chanmon_cfgs(6);
1429 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1430 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1431 let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1433 // Create some initial channels to route via 3 to 4/5 from 0/1/2
1434 create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1435 create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1436 create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1437 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1438 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1440 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1442 *nodes[0].network_payment_count.borrow_mut() -= 1;
1443 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1445 *nodes[0].network_payment_count.borrow_mut() -= 1;
1446 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1448 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1449 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1450 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1454 fn test_duplicate_htlc_different_direction_onchain() {
1455 // Test that ChannelMonitor doesn't generate 2 preimage txn
1456 // when we have 2 HTLCs with same preimage that go across a node
1457 // in opposite directions.
1458 let chanmon_cfgs = create_chanmon_cfgs(2);
1459 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1460 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1461 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1463 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1464 let logger = test_utils::TestLogger::new();
1467 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1469 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1471 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1472 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1473 send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1475 // Provide preimage to node 0 by claiming payment
1476 nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1477 check_added_monitors!(nodes[0], 1);
1479 // Broadcast node 1 commitment txn
1480 let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1482 assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1483 let mut has_both_htlcs = 0; // check htlcs match ones committed
1484 for outp in remote_txn[0].output.iter() {
1485 if outp.value == 800_000 / 1000 {
1486 has_both_htlcs += 1;
1487 } else if outp.value == 900_000 / 1000 {
1488 has_both_htlcs += 1;
1491 assert_eq!(has_both_htlcs, 2);
1493 mine_transaction(&nodes[0], &remote_txn[0]);
1494 check_added_monitors!(nodes[0], 1);
1496 // Check we only broadcast 1 timeout tx
1497 let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1498 let htlc_pair = if claim_txn[0].output[0].value == 800_000 / 1000 { (claim_txn[0].clone(), claim_txn[1].clone()) } else { (claim_txn[1].clone(), claim_txn[0].clone()) };
1499 assert_eq!(claim_txn.len(), 5);
1500 check_spends!(claim_txn[2], chan_1.3);
1501 check_spends!(claim_txn[3], claim_txn[2]);
1502 assert_eq!(htlc_pair.0.input.len(), 1);
1503 assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1504 check_spends!(htlc_pair.0, remote_txn[0]);
1505 assert_eq!(htlc_pair.1.input.len(), 1);
1506 assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1507 check_spends!(htlc_pair.1, remote_txn[0]);
1509 let events = nodes[0].node.get_and_clear_pending_msg_events();
1510 assert_eq!(events.len(), 3);
1513 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1514 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1515 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1516 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1518 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, .. } } => {
1519 assert!(update_add_htlcs.is_empty());
1520 assert!(update_fail_htlcs.is_empty());
1521 assert_eq!(update_fulfill_htlcs.len(), 1);
1522 assert!(update_fail_malformed_htlcs.is_empty());
1523 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1525 _ => panic!("Unexpected event"),
1531 fn test_basic_channel_reserve() {
1532 let chanmon_cfgs = create_chanmon_cfgs(2);
1533 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1534 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1535 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1536 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1537 let logger = test_utils::TestLogger::new();
1539 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1540 let channel_reserve = chan_stat.channel_reserve_msat;
1542 // The 2* and +1 are for the fee spike reserve.
1543 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1544 let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1545 let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1546 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1547 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), None, None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1548 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1550 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1552 &APIError::ChannelUnavailable{ref err} =>
1553 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1554 _ => panic!("Unexpected error variant"),
1557 _ => panic!("Unexpected error variant"),
1559 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1560 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);
1562 send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1566 fn test_fee_spike_violation_fails_htlc() {
1567 let chanmon_cfgs = create_chanmon_cfgs(2);
1568 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1569 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1570 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1571 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1572 let logger = test_utils::TestLogger::new();
1574 macro_rules! get_route_and_payment_hash {
1575 ($recv_value: expr) => {{
1576 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1577 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
1578 let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1579 (route, payment_hash, payment_preimage)
1583 let (route, payment_hash, _) = get_route_and_payment_hash!(3460001);
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]).expect("RNG is bad!");
1588 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1590 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1591 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1592 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1593 let msg = msgs::UpdateAddHTLC {
1596 amount_msat: htlc_msat,
1597 payment_hash: payment_hash,
1598 cltv_expiry: htlc_cltv,
1599 onion_routing_packet: onion_packet,
1602 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1604 // Now manually create the commitment_signed message corresponding to the update_add
1605 // nodes[0] just sent. In the code for construction of this message, "local" refers
1606 // to the sender of the message, and "remote" refers to the receiver.
1608 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1610 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1612 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1613 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1614 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1615 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1616 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1617 let chan_signer = local_chan.get_signer();
1618 let pubkeys = chan_signer.pubkeys();
1619 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1620 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1621 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1623 let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1624 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1625 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1626 let chan_signer = remote_chan.get_signer();
1627 let pubkeys = chan_signer.pubkeys();
1628 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1629 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1632 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1633 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1634 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1636 // Build the remote commitment transaction so we can sign it, and then later use the
1637 // signature for the commitment_signed message.
1638 let local_chan_balance = 1313;
1640 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1642 amount_msat: 3460001,
1643 cltv_expiry: htlc_cltv,
1645 transaction_output_index: Some(1),
1648 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1651 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1652 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1653 let local_chan_signer = local_chan.get_signer();
1654 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1658 commit_tx_keys.clone(),
1660 &mut vec![(accepted_htlc_info, ())],
1661 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1663 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1666 let commit_signed_msg = msgs::CommitmentSigned {
1669 htlc_signatures: res.1
1672 // Send the commitment_signed message to the nodes[1].
1673 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1674 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1676 // Send the RAA to nodes[1].
1677 let raa_msg = msgs::RevokeAndACK {
1679 per_commitment_secret: local_secret,
1680 next_per_commitment_point: next_local_point
1682 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1684 let events = nodes[1].node.get_and_clear_pending_msg_events();
1685 assert_eq!(events.len(), 1);
1686 // Make sure the HTLC failed in the way we expect.
1688 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1689 assert_eq!(update_fail_htlcs.len(), 1);
1690 update_fail_htlcs[0].clone()
1692 _ => panic!("Unexpected event"),
1694 nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1696 check_added_monitors!(nodes[1], 2);
1700 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1701 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1702 // Set the fee rate for the channel very high, to the point where the fundee
1703 // sending any above-dust amount would result in a channel reserve violation.
1704 // In this test we check that we would be prevented from sending an HTLC in
1706 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1707 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1708 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1709 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1710 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1711 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1712 let logger = test_utils::TestLogger::new();
1714 macro_rules! get_route_and_payment_hash {
1715 ($recv_value: expr) => {{
1716 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1717 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1718 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.first().unwrap().node.get_our_node_id(), None, None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1719 (route, payment_hash, payment_preimage)
1723 let (route, our_payment_hash, _) = get_route_and_payment_hash!(4843000);
1724 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1725 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1726 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1727 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);
1731 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1732 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1733 // Set the fee rate for the channel very high, to the point where the funder
1734 // receiving 1 update_add_htlc would result in them closing the channel due
1735 // to channel reserve violation. This close could also happen if the fee went
1736 // up a more realistic amount, but many HTLCs were outstanding at the time of
1737 // the update_add_htlc.
1738 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1739 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1740 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1741 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1742 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1743 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1744 let logger = test_utils::TestLogger::new();
1746 macro_rules! get_route_and_payment_hash {
1747 ($recv_value: expr) => {{
1748 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1749 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1750 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.first().unwrap().node.get_our_node_id(), None, None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1751 (route, payment_hash, payment_preimage)
1755 let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1756 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1757 let secp_ctx = Secp256k1::new();
1758 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1759 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1760 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1761 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1762 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1763 let msg = msgs::UpdateAddHTLC {
1766 amount_msat: htlc_msat + 1,
1767 payment_hash: payment_hash,
1768 cltv_expiry: htlc_cltv,
1769 onion_routing_packet: onion_packet,
1772 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1773 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1774 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);
1775 assert_eq!(nodes[0].node.list_channels().len(), 0);
1776 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1777 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1778 check_added_monitors!(nodes[0], 1);
1782 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1783 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1784 // calculating our commitment transaction fee (this was previously broken).
1785 let chanmon_cfgs = create_chanmon_cfgs(2);
1786 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1787 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1788 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1790 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1791 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1792 // transaction fee with 0 HTLCs (183 sats)).
1793 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1795 let dust_amt = 329000; // Dust amount
1796 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1797 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1798 // commitment transaction fee.
1799 let (_, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1803 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1804 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1805 // calculating our counterparty's commitment transaction fee (this was previously broken).
1806 let chanmon_cfgs = create_chanmon_cfgs(2);
1807 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1808 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1809 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1810 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1812 let payment_amt = 46000; // Dust amount
1813 // In the previous code, these first four payments would succeed.
1814 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1815 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1816 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1817 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1819 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1820 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1821 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1822 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1823 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1824 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1826 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1827 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1828 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1829 let (_, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1833 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1834 let chanmon_cfgs = create_chanmon_cfgs(3);
1835 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1836 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1837 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1838 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1839 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1840 let logger = test_utils::TestLogger::new();
1842 macro_rules! get_route_and_payment_hash {
1843 ($recv_value: expr) => {{
1844 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1845 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1846 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), None, None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1847 (route, payment_hash, payment_preimage)
1852 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1853 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1854 let feerate = get_feerate!(nodes[0], chan.2);
1856 // Add a 2* and +1 for the fee spike reserve.
1857 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1858 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;
1859 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1861 // Add a pending HTLC.
1862 let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1863 let payment_event_1 = {
1864 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1865 check_added_monitors!(nodes[0], 1);
1867 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1868 assert_eq!(events.len(), 1);
1869 SendEvent::from_event(events.remove(0))
1871 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1873 // Attempt to trigger a channel reserve violation --> payment failure.
1874 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1875 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;
1876 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1877 let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1879 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1880 let secp_ctx = Secp256k1::new();
1881 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1882 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1883 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1884 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1885 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1886 let msg = msgs::UpdateAddHTLC {
1889 amount_msat: htlc_msat + 1,
1890 payment_hash: our_payment_hash_1,
1891 cltv_expiry: htlc_cltv,
1892 onion_routing_packet: onion_packet,
1895 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1896 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1897 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1898 assert_eq!(nodes[1].node.list_channels().len(), 1);
1899 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1900 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1901 check_added_monitors!(nodes[1], 1);
1905 fn test_inbound_outbound_capacity_is_not_zero() {
1906 let chanmon_cfgs = create_chanmon_cfgs(2);
1907 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1908 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1909 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1910 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1911 let channels0 = node_chanmgrs[0].list_channels();
1912 let channels1 = node_chanmgrs[1].list_channels();
1913 assert_eq!(channels0.len(), 1);
1914 assert_eq!(channels1.len(), 1);
1916 assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1917 assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1919 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1920 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1923 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1924 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1928 fn test_channel_reserve_holding_cell_htlcs() {
1929 let chanmon_cfgs = create_chanmon_cfgs(3);
1930 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1931 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1932 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1933 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1934 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1935 let logger = test_utils::TestLogger::new();
1937 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1938 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1940 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1941 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1943 macro_rules! get_route_and_payment_hash {
1944 ($recv_value: expr) => {{
1945 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1946 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1947 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), None, None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1948 (route, payment_hash, payment_preimage)
1952 macro_rules! expect_forward {
1954 let mut events = $node.node.get_and_clear_pending_msg_events();
1955 assert_eq!(events.len(), 1);
1956 check_added_monitors!($node, 1);
1957 let payment_event = SendEvent::from_event(events.remove(0));
1962 let feemsat = 239; // somehow we know?
1963 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1964 let feerate = get_feerate!(nodes[0], chan_1.2);
1966 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1968 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1970 let (mut route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0);
1971 route.paths[0].last_mut().unwrap().fee_msat += 1;
1972 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1973 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1974 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)));
1975 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1976 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);
1979 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1980 // nodes[0]'s wealth
1982 let amt_msat = recv_value_0 + total_fee_msat;
1983 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1984 // Also, ensure that each payment has enough to be over the dust limit to
1985 // ensure it'll be included in each commit tx fee calculation.
1986 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1987 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1988 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1991 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1993 let (stat01_, stat11_, stat12_, stat22_) = (
1994 get_channel_value_stat!(nodes[0], chan_1.2),
1995 get_channel_value_stat!(nodes[1], chan_1.2),
1996 get_channel_value_stat!(nodes[1], chan_2.2),
1997 get_channel_value_stat!(nodes[2], chan_2.2),
2000 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
2001 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
2002 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
2003 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
2004 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
2007 // adding pending output.
2008 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
2009 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
2010 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
2011 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
2012 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
2013 // cases where 1 msat over X amount will cause a payment failure, but anything less than
2014 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
2015 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
2016 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
2018 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
2019 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
2020 let amt_msat_1 = recv_value_1 + total_fee_msat;
2022 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
2023 let payment_event_1 = {
2024 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
2025 check_added_monitors!(nodes[0], 1);
2027 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2028 assert_eq!(events.len(), 1);
2029 SendEvent::from_event(events.remove(0))
2031 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
2033 // channel reserve test with htlc pending output > 0
2034 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2036 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
2037 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2038 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2039 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2042 // split the rest to test holding cell
2043 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2044 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2045 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2046 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2048 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2049 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);
2052 // now see if they go through on both sides
2053 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2054 // but this will stuck in the holding cell
2055 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2056 check_added_monitors!(nodes[0], 0);
2057 let events = nodes[0].node.get_and_clear_pending_events();
2058 assert_eq!(events.len(), 0);
2060 // test with outbound holding cell amount > 0
2062 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2063 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2064 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2065 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2066 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);
2069 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2070 // this will also stuck in the holding cell
2071 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2072 check_added_monitors!(nodes[0], 0);
2073 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2074 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2076 // flush the pending htlc
2077 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2078 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2079 check_added_monitors!(nodes[1], 1);
2081 // the pending htlc should be promoted to committed
2082 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2083 check_added_monitors!(nodes[0], 1);
2084 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2086 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2087 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2088 // No commitment_signed so get_event_msg's assert(len == 1) passes
2089 check_added_monitors!(nodes[0], 1);
2091 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2092 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2093 check_added_monitors!(nodes[1], 1);
2095 expect_pending_htlcs_forwardable!(nodes[1]);
2097 let ref payment_event_11 = expect_forward!(nodes[1]);
2098 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2099 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2101 expect_pending_htlcs_forwardable!(nodes[2]);
2102 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2104 // flush the htlcs in the holding cell
2105 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2106 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2107 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2108 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2109 expect_pending_htlcs_forwardable!(nodes[1]);
2111 let ref payment_event_3 = expect_forward!(nodes[1]);
2112 assert_eq!(payment_event_3.msgs.len(), 2);
2113 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2114 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2116 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2117 expect_pending_htlcs_forwardable!(nodes[2]);
2119 let events = nodes[2].node.get_and_clear_pending_events();
2120 assert_eq!(events.len(), 2);
2122 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2123 assert_eq!(our_payment_hash_21, *payment_hash);
2124 assert_eq!(*payment_secret, None);
2125 assert_eq!(recv_value_21, amt);
2127 _ => panic!("Unexpected event"),
2130 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2131 assert_eq!(our_payment_hash_22, *payment_hash);
2132 assert_eq!(None, *payment_secret);
2133 assert_eq!(recv_value_22, amt);
2135 _ => panic!("Unexpected event"),
2138 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2139 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2140 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2142 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2143 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2144 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2146 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2147 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);
2148 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2149 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2150 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2152 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2153 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2157 fn channel_reserve_in_flight_removes() {
2158 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2159 // can send to its counterparty, but due to update ordering, the other side may not yet have
2160 // considered those HTLCs fully removed.
2161 // This tests that we don't count HTLCs which will not be included in the next remote
2162 // commitment transaction towards the reserve value (as it implies no commitment transaction
2163 // will be generated which violates the remote reserve value).
2164 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2166 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2167 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2168 // you only consider the value of the first HTLC, it may not),
2169 // * start routing a third HTLC from A to B,
2170 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2171 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2172 // * deliver the first fulfill from B
2173 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2175 // * deliver A's response CS and RAA.
2176 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2177 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2178 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2179 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2180 let chanmon_cfgs = create_chanmon_cfgs(2);
2181 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2182 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2183 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2184 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2185 let logger = test_utils::TestLogger::new();
2187 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2188 // Route the first two HTLCs.
2189 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2190 let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2192 // Start routing the third HTLC (this is just used to get everyone in the right state).
2193 let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2195 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2196 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2197 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2198 check_added_monitors!(nodes[0], 1);
2199 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2200 assert_eq!(events.len(), 1);
2201 SendEvent::from_event(events.remove(0))
2204 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2205 // initial fulfill/CS.
2206 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2207 check_added_monitors!(nodes[1], 1);
2208 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2210 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2211 // remove the second HTLC when we send the HTLC back from B to A.
2212 assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2213 check_added_monitors!(nodes[1], 1);
2214 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2216 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2217 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2218 check_added_monitors!(nodes[0], 1);
2219 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2220 expect_payment_sent!(nodes[0], payment_preimage_1);
2222 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2223 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2224 check_added_monitors!(nodes[1], 1);
2225 // B is already AwaitingRAA, so cant generate a CS here
2226 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2228 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2229 check_added_monitors!(nodes[1], 1);
2230 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2232 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2233 check_added_monitors!(nodes[0], 1);
2234 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2236 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2237 check_added_monitors!(nodes[1], 1);
2238 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2240 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2241 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2242 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2243 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2244 // on-chain as necessary).
2245 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2246 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2247 check_added_monitors!(nodes[0], 1);
2248 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2249 expect_payment_sent!(nodes[0], payment_preimage_2);
2251 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2252 check_added_monitors!(nodes[1], 1);
2253 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2255 expect_pending_htlcs_forwardable!(nodes[1]);
2256 expect_payment_received!(nodes[1], payment_hash_3, 100000);
2258 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2259 // resolve the second HTLC from A's point of view.
2260 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2261 check_added_monitors!(nodes[0], 1);
2262 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2264 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2265 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2266 let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2268 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2269 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2270 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2271 check_added_monitors!(nodes[1], 1);
2272 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2273 assert_eq!(events.len(), 1);
2274 SendEvent::from_event(events.remove(0))
2277 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2278 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2279 check_added_monitors!(nodes[0], 1);
2280 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2282 // Now just resolve all the outstanding messages/HTLCs for completeness...
2284 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2285 check_added_monitors!(nodes[1], 1);
2286 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2288 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2289 check_added_monitors!(nodes[1], 1);
2291 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2292 check_added_monitors!(nodes[0], 1);
2293 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2295 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2296 check_added_monitors!(nodes[1], 1);
2297 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2299 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2300 check_added_monitors!(nodes[0], 1);
2302 expect_pending_htlcs_forwardable!(nodes[0]);
2303 expect_payment_received!(nodes[0], payment_hash_4, 10000);
2305 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2306 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2310 fn channel_monitor_network_test() {
2311 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2312 // tests that ChannelMonitor is able to recover from various states.
2313 let chanmon_cfgs = create_chanmon_cfgs(5);
2314 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2315 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2316 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2318 // Create some initial channels
2319 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2320 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2321 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2322 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2324 // Make sure all nodes are at the same starting height
2325 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2326 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2327 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2328 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2329 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2331 // Rebalance the network a bit by relaying one payment through all the channels...
2332 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2333 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2334 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2335 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2337 // Simple case with no pending HTLCs:
2338 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2339 check_added_monitors!(nodes[1], 1);
2340 check_closed_broadcast!(nodes[1], false);
2342 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2343 assert_eq!(node_txn.len(), 1);
2344 mine_transaction(&nodes[0], &node_txn[0]);
2345 check_added_monitors!(nodes[0], 1);
2346 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2348 check_closed_broadcast!(nodes[0], true);
2349 assert_eq!(nodes[0].node.list_channels().len(), 0);
2350 assert_eq!(nodes[1].node.list_channels().len(), 1);
2352 // One pending HTLC is discarded by the force-close:
2353 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2355 // Simple case of one pending HTLC to HTLC-Timeout
2356 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2357 check_closed_broadcast!(nodes[1], false);
2358 check_added_monitors!(nodes[1], 1);
2360 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2361 mine_transaction(&nodes[2], &node_txn[0]);
2362 check_added_monitors!(nodes[2], 1);
2363 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2365 check_closed_broadcast!(nodes[2], true);
2366 assert_eq!(nodes[1].node.list_channels().len(), 0);
2367 assert_eq!(nodes[2].node.list_channels().len(), 1);
2369 macro_rules! claim_funds {
2370 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2372 assert!($node.node.claim_funds($preimage, &None, $amount));
2373 check_added_monitors!($node, 1);
2375 let events = $node.node.get_and_clear_pending_msg_events();
2376 assert_eq!(events.len(), 1);
2378 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2379 assert!(update_add_htlcs.is_empty());
2380 assert!(update_fail_htlcs.is_empty());
2381 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2383 _ => panic!("Unexpected event"),
2389 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2390 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2391 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2392 check_added_monitors!(nodes[2], 1);
2393 check_closed_broadcast!(nodes[2], false);
2394 let node2_commitment_txid;
2396 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2397 node2_commitment_txid = node_txn[0].txid();
2399 // Claim the payment on nodes[3], giving it knowledge of the preimage
2400 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2401 mine_transaction(&nodes[3], &node_txn[0]);
2402 check_added_monitors!(nodes[3], 1);
2403 check_preimage_claim(&nodes[3], &node_txn);
2405 check_closed_broadcast!(nodes[3], true);
2406 assert_eq!(nodes[2].node.list_channels().len(), 0);
2407 assert_eq!(nodes[3].node.list_channels().len(), 1);
2409 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2410 // confusing us in the following tests.
2411 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2413 // One pending HTLC to time out:
2414 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2415 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2418 let (close_chan_update_1, close_chan_update_2) = {
2419 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2420 let events = nodes[3].node.get_and_clear_pending_msg_events();
2421 assert_eq!(events.len(), 2);
2422 let close_chan_update_1 = match events[0] {
2423 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2426 _ => panic!("Unexpected event"),
2429 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2430 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2432 _ => panic!("Unexpected event"),
2434 check_added_monitors!(nodes[3], 1);
2436 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2438 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2439 node_txn.retain(|tx| {
2440 if tx.input[0].previous_output.txid == node2_commitment_txid {
2446 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2448 // Claim the payment on nodes[4], giving it knowledge of the preimage
2449 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2451 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2452 let events = nodes[4].node.get_and_clear_pending_msg_events();
2453 assert_eq!(events.len(), 2);
2454 let close_chan_update_2 = match events[0] {
2455 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2458 _ => panic!("Unexpected event"),
2461 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2462 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2464 _ => panic!("Unexpected event"),
2466 check_added_monitors!(nodes[4], 1);
2467 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2469 mine_transaction(&nodes[4], &node_txn[0]);
2470 check_preimage_claim(&nodes[4], &node_txn);
2471 (close_chan_update_1, close_chan_update_2)
2473 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2474 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2475 assert_eq!(nodes[3].node.list_channels().len(), 0);
2476 assert_eq!(nodes[4].node.list_channels().len(), 0);
2478 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2482 fn test_justice_tx() {
2483 // Test justice txn built on revoked HTLC-Success tx, against both sides
2484 let mut alice_config = UserConfig::default();
2485 alice_config.channel_options.announced_channel = true;
2486 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2487 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2488 let mut bob_config = UserConfig::default();
2489 bob_config.channel_options.announced_channel = true;
2490 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2491 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2492 let user_cfgs = [Some(alice_config), Some(bob_config)];
2493 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2494 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2495 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2496 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2497 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2498 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2499 // Create some new channels:
2500 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2502 // A pending HTLC which will be revoked:
2503 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2504 // Get the will-be-revoked local txn from nodes[0]
2505 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2506 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2507 assert_eq!(revoked_local_txn[0].input.len(), 1);
2508 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2509 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2510 assert_eq!(revoked_local_txn[1].input.len(), 1);
2511 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2512 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2513 // Revoke the old state
2514 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2517 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2519 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2520 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2521 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2523 check_spends!(node_txn[0], revoked_local_txn[0]);
2524 node_txn.swap_remove(0);
2525 node_txn.truncate(1);
2527 check_added_monitors!(nodes[1], 1);
2528 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2530 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2531 // Verify broadcast of revoked HTLC-timeout
2532 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2533 check_added_monitors!(nodes[0], 1);
2534 // Broadcast revoked HTLC-timeout on node 1
2535 mine_transaction(&nodes[1], &node_txn[1]);
2536 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2538 get_announce_close_broadcast_events(&nodes, 0, 1);
2540 assert_eq!(nodes[0].node.list_channels().len(), 0);
2541 assert_eq!(nodes[1].node.list_channels().len(), 0);
2543 // We test justice_tx build by A on B's revoked HTLC-Success tx
2544 // Create some new channels:
2545 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2547 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2551 // A pending HTLC which will be revoked:
2552 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2553 // Get the will-be-revoked local txn from B
2554 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2555 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2556 assert_eq!(revoked_local_txn[0].input.len(), 1);
2557 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2558 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2559 // Revoke the old state
2560 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2562 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2564 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2565 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2566 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2568 check_spends!(node_txn[0], revoked_local_txn[0]);
2569 node_txn.swap_remove(0);
2571 check_added_monitors!(nodes[0], 1);
2572 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2574 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2575 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2576 check_added_monitors!(nodes[1], 1);
2577 mine_transaction(&nodes[0], &node_txn[1]);
2578 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2580 get_announce_close_broadcast_events(&nodes, 0, 1);
2581 assert_eq!(nodes[0].node.list_channels().len(), 0);
2582 assert_eq!(nodes[1].node.list_channels().len(), 0);
2586 fn revoked_output_claim() {
2587 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2588 // transaction is broadcast by its counterparty
2589 let chanmon_cfgs = create_chanmon_cfgs(2);
2590 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2591 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2592 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2593 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2594 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2595 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2596 assert_eq!(revoked_local_txn.len(), 1);
2597 // Only output is the full channel value back to nodes[0]:
2598 assert_eq!(revoked_local_txn[0].output.len(), 1);
2599 // Send a payment through, updating everyone's latest commitment txn
2600 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2602 // Inform nodes[1] that nodes[0] broadcast a stale tx
2603 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2604 check_added_monitors!(nodes[1], 1);
2605 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2606 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2608 check_spends!(node_txn[0], revoked_local_txn[0]);
2609 check_spends!(node_txn[1], chan_1.3);
2611 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2612 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2613 get_announce_close_broadcast_events(&nodes, 0, 1);
2614 check_added_monitors!(nodes[0], 1)
2618 fn claim_htlc_outputs_shared_tx() {
2619 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2620 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2621 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2622 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2623 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2624 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2626 // Create some new channel:
2627 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2629 // Rebalance the network to generate htlc in the two directions
2630 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2631 // 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
2632 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2633 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2635 // Get the will-be-revoked local txn from node[0]
2636 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2637 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2638 assert_eq!(revoked_local_txn[0].input.len(), 1);
2639 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2640 assert_eq!(revoked_local_txn[1].input.len(), 1);
2641 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2642 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2643 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2645 //Revoke the old state
2646 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2649 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2650 check_added_monitors!(nodes[0], 1);
2651 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2652 check_added_monitors!(nodes[1], 1);
2653 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2654 expect_payment_failed!(nodes[1], payment_hash_2, true);
2656 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2657 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2659 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2660 check_spends!(node_txn[0], revoked_local_txn[0]);
2662 let mut witness_lens = BTreeSet::new();
2663 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2664 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2665 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2666 assert_eq!(witness_lens.len(), 3);
2667 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2668 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2669 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2671 // Next nodes[1] broadcasts its current local tx state:
2672 assert_eq!(node_txn[1].input.len(), 1);
2673 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2675 assert_eq!(node_txn[2].input.len(), 1);
2676 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2677 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2678 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2679 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2680 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2682 get_announce_close_broadcast_events(&nodes, 0, 1);
2683 assert_eq!(nodes[0].node.list_channels().len(), 0);
2684 assert_eq!(nodes[1].node.list_channels().len(), 0);
2688 fn claim_htlc_outputs_single_tx() {
2689 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2690 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2691 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2692 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2693 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2694 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2696 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2698 // Rebalance the network to generate htlc in the two directions
2699 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2700 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx, but this
2701 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2702 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2703 let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2705 // Get the will-be-revoked local txn from node[0]
2706 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2708 //Revoke the old state
2709 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2712 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2713 check_added_monitors!(nodes[0], 1);
2714 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2715 check_added_monitors!(nodes[1], 1);
2716 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2718 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2719 expect_payment_failed!(nodes[1], payment_hash_2, true);
2721 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2722 assert_eq!(node_txn.len(), 9);
2723 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2724 // ChannelManager: local commmitment + local HTLC-timeout (2)
2725 // 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)
2726 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2728 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2729 assert_eq!(node_txn[0].input.len(), 1);
2730 check_spends!(node_txn[0], chan_1.3);
2731 assert_eq!(node_txn[1].input.len(), 1);
2732 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2733 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2734 check_spends!(node_txn[1], node_txn[0]);
2736 // Justice transactions are indices 1-2-4
2737 assert_eq!(node_txn[2].input.len(), 1);
2738 assert_eq!(node_txn[3].input.len(), 1);
2739 assert_eq!(node_txn[4].input.len(), 1);
2741 check_spends!(node_txn[2], revoked_local_txn[0]);
2742 check_spends!(node_txn[3], revoked_local_txn[0]);
2743 check_spends!(node_txn[4], revoked_local_txn[0]);
2745 let mut witness_lens = BTreeSet::new();
2746 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2747 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2748 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2749 assert_eq!(witness_lens.len(), 3);
2750 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2751 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2752 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2754 get_announce_close_broadcast_events(&nodes, 0, 1);
2755 assert_eq!(nodes[0].node.list_channels().len(), 0);
2756 assert_eq!(nodes[1].node.list_channels().len(), 0);
2760 fn test_htlc_on_chain_success() {
2761 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2762 // the preimage backward accordingly. So here we test that ChannelManager is
2763 // broadcasting the right event to other nodes in payment path.
2764 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2765 // A --------------------> B ----------------------> C (preimage)
2766 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2767 // commitment transaction was broadcast.
2768 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2770 // B should be able to claim via preimage if A then broadcasts its local tx.
2771 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2772 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2773 // PaymentSent event).
2775 let chanmon_cfgs = create_chanmon_cfgs(3);
2776 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2777 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2778 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2780 // Create some initial channels
2781 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2782 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2784 // Rebalance the network a bit by relaying one payment through all the channels...
2785 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2786 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2788 let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2789 let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2791 // Broadcast legit commitment tx from C on B's chain
2792 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2793 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2794 assert_eq!(commitment_tx.len(), 1);
2795 check_spends!(commitment_tx[0], chan_2.3);
2796 nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2797 nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2798 check_added_monitors!(nodes[2], 2);
2799 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2800 assert!(updates.update_add_htlcs.is_empty());
2801 assert!(updates.update_fail_htlcs.is_empty());
2802 assert!(updates.update_fail_malformed_htlcs.is_empty());
2803 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2805 mine_transaction(&nodes[2], &commitment_tx[0]);
2806 check_closed_broadcast!(nodes[2], true);
2807 check_added_monitors!(nodes[2], 1);
2808 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)
2809 assert_eq!(node_txn.len(), 5);
2810 assert_eq!(node_txn[0], node_txn[3]);
2811 assert_eq!(node_txn[1], node_txn[4]);
2812 assert_eq!(node_txn[2], commitment_tx[0]);
2813 check_spends!(node_txn[0], commitment_tx[0]);
2814 check_spends!(node_txn[1], commitment_tx[0]);
2815 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2816 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2817 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2818 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2819 assert_eq!(node_txn[0].lock_time, 0);
2820 assert_eq!(node_txn[1].lock_time, 0);
2822 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2823 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2824 connect_block(&nodes[1], &Block { header, txdata: node_txn});
2826 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2827 assert_eq!(added_monitors.len(), 1);
2828 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2829 added_monitors.clear();
2831 let events = nodes[1].node.get_and_clear_pending_msg_events();
2833 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2834 assert_eq!(added_monitors.len(), 2);
2835 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2836 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2837 added_monitors.clear();
2839 assert_eq!(events.len(), 3);
2841 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2842 _ => panic!("Unexpected event"),
2845 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2846 _ => panic!("Unexpected event"),
2850 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, .. } } => {
2851 assert!(update_add_htlcs.is_empty());
2852 assert!(update_fail_htlcs.is_empty());
2853 assert_eq!(update_fulfill_htlcs.len(), 1);
2854 assert!(update_fail_malformed_htlcs.is_empty());
2855 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2857 _ => panic!("Unexpected event"),
2859 macro_rules! check_tx_local_broadcast {
2860 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2861 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2862 assert_eq!(node_txn.len(), 5);
2863 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2864 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2865 check_spends!(node_txn[0], $commitment_tx);
2866 check_spends!(node_txn[1], $commitment_tx);
2867 assert_ne!(node_txn[0].lock_time, 0);
2868 assert_ne!(node_txn[1].lock_time, 0);
2870 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2871 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2872 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2873 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2875 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2876 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2877 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2878 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2880 check_spends!(node_txn[2], $chan_tx);
2881 check_spends!(node_txn[3], node_txn[2]);
2882 check_spends!(node_txn[4], node_txn[2]);
2883 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2884 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2885 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2886 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2887 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2888 assert_ne!(node_txn[3].lock_time, 0);
2889 assert_ne!(node_txn[4].lock_time, 0);
2893 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2894 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2895 // timeout-claim of the output that nodes[2] just claimed via success.
2896 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2898 // Broadcast legit commitment tx from A on B's chain
2899 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2900 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2901 check_spends!(commitment_tx[0], chan_1.3);
2902 mine_transaction(&nodes[1], &commitment_tx[0]);
2903 check_closed_broadcast!(nodes[1], true);
2904 check_added_monitors!(nodes[1], 1);
2905 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2906 assert_eq!(node_txn.len(), 4);
2907 check_spends!(node_txn[0], commitment_tx[0]);
2908 assert_eq!(node_txn[0].input.len(), 2);
2909 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2910 assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2911 assert_eq!(node_txn[0].lock_time, 0);
2912 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2913 check_spends!(node_txn[1], chan_1.3);
2914 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2915 check_spends!(node_txn[2], node_txn[1]);
2916 check_spends!(node_txn[3], node_txn[1]);
2917 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2918 // we already checked the same situation with A.
2920 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2921 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2922 connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] });
2923 check_closed_broadcast!(nodes[0], true);
2924 check_added_monitors!(nodes[0], 1);
2925 let events = nodes[0].node.get_and_clear_pending_events();
2926 assert_eq!(events.len(), 2);
2927 let mut first_claimed = false;
2928 for event in events {
2930 Event::PaymentSent { payment_preimage } => {
2931 if payment_preimage == our_payment_preimage {
2932 assert!(!first_claimed);
2933 first_claimed = true;
2935 assert_eq!(payment_preimage, our_payment_preimage_2);
2938 _ => panic!("Unexpected event"),
2941 check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2944 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2945 // Test that in case of a unilateral close onchain, we detect the state of output and
2946 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2947 // broadcasting the right event to other nodes in payment path.
2948 // A ------------------> B ----------------------> C (timeout)
2949 // B's commitment tx C's commitment tx
2951 // B's HTLC timeout tx B's timeout tx
2953 let chanmon_cfgs = create_chanmon_cfgs(3);
2954 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2955 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2956 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2957 *nodes[0].connect_style.borrow_mut() = connect_style;
2958 *nodes[1].connect_style.borrow_mut() = connect_style;
2959 *nodes[2].connect_style.borrow_mut() = connect_style;
2961 // Create some intial channels
2962 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2963 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2965 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2966 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2967 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2969 let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2971 // Broadcast legit commitment tx from C on B's chain
2972 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2973 check_spends!(commitment_tx[0], chan_2.3);
2974 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2975 check_added_monitors!(nodes[2], 0);
2976 expect_pending_htlcs_forwardable!(nodes[2]);
2977 check_added_monitors!(nodes[2], 1);
2979 let events = nodes[2].node.get_and_clear_pending_msg_events();
2980 assert_eq!(events.len(), 1);
2982 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, .. } } => {
2983 assert!(update_add_htlcs.is_empty());
2984 assert!(!update_fail_htlcs.is_empty());
2985 assert!(update_fulfill_htlcs.is_empty());
2986 assert!(update_fail_malformed_htlcs.is_empty());
2987 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2989 _ => panic!("Unexpected event"),
2991 mine_transaction(&nodes[2], &commitment_tx[0]);
2992 check_closed_broadcast!(nodes[2], true);
2993 check_added_monitors!(nodes[2], 1);
2994 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2995 assert_eq!(node_txn.len(), 1);
2996 check_spends!(node_txn[0], chan_2.3);
2997 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2999 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
3000 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
3001 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
3002 mine_transaction(&nodes[1], &commitment_tx[0]);
3005 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3006 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
3007 assert_eq!(node_txn[0], node_txn[3]);
3008 assert_eq!(node_txn[1], node_txn[4]);
3010 check_spends!(node_txn[2], commitment_tx[0]);
3011 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3013 check_spends!(node_txn[0], chan_2.3);
3014 check_spends!(node_txn[1], node_txn[0]);
3015 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
3016 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3018 timeout_tx = node_txn[2].clone();
3022 mine_transaction(&nodes[1], &timeout_tx);
3023 check_added_monitors!(nodes[1], 1);
3024 check_closed_broadcast!(nodes[1], true);
3026 // B will rebroadcast a fee-bumped timeout transaction here.
3027 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3028 assert_eq!(node_txn.len(), 1);
3029 check_spends!(node_txn[0], commitment_tx[0]);
3032 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3034 // B will rebroadcast its own holder commitment transaction here...just because
3035 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3036 assert_eq!(node_txn.len(), 1);
3037 check_spends!(node_txn[0], chan_2.3);
3040 expect_pending_htlcs_forwardable!(nodes[1]);
3041 check_added_monitors!(nodes[1], 1);
3042 let events = nodes[1].node.get_and_clear_pending_msg_events();
3043 assert_eq!(events.len(), 1);
3045 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, .. } } => {
3046 assert!(update_add_htlcs.is_empty());
3047 assert!(!update_fail_htlcs.is_empty());
3048 assert!(update_fulfill_htlcs.is_empty());
3049 assert!(update_fail_malformed_htlcs.is_empty());
3050 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3052 _ => panic!("Unexpected event"),
3055 // Broadcast legit commitment tx from B on A's chain
3056 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3057 check_spends!(commitment_tx[0], chan_1.3);
3059 mine_transaction(&nodes[0], &commitment_tx[0]);
3061 check_closed_broadcast!(nodes[0], true);
3062 check_added_monitors!(nodes[0], 1);
3063 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3064 assert_eq!(node_txn.len(), 3);
3065 check_spends!(node_txn[0], commitment_tx[0]);
3066 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3067 check_spends!(node_txn[1], chan_1.3);
3068 check_spends!(node_txn[2], node_txn[1]);
3069 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3070 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3074 fn test_htlc_on_chain_timeout() {
3075 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3076 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3077 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3081 fn test_simple_commitment_revoked_fail_backward() {
3082 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3083 // and fail backward accordingly.
3085 let chanmon_cfgs = create_chanmon_cfgs(3);
3086 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3087 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3088 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3090 // Create some initial channels
3091 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3092 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3094 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3095 // Get the will-be-revoked local txn from nodes[2]
3096 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3097 // Revoke the old state
3098 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3100 let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3102 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3103 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3104 check_added_monitors!(nodes[1], 1);
3105 check_closed_broadcast!(nodes[1], true);
3107 expect_pending_htlcs_forwardable!(nodes[1]);
3108 check_added_monitors!(nodes[1], 1);
3109 let events = nodes[1].node.get_and_clear_pending_msg_events();
3110 assert_eq!(events.len(), 1);
3112 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, .. } } => {
3113 assert!(update_add_htlcs.is_empty());
3114 assert_eq!(update_fail_htlcs.len(), 1);
3115 assert!(update_fulfill_htlcs.is_empty());
3116 assert!(update_fail_malformed_htlcs.is_empty());
3117 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3119 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3120 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3122 let events = nodes[0].node.get_and_clear_pending_msg_events();
3123 assert_eq!(events.len(), 1);
3125 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3126 _ => panic!("Unexpected event"),
3128 expect_payment_failed!(nodes[0], payment_hash, false);
3130 _ => panic!("Unexpected event"),
3134 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3135 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3136 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3137 // commitment transaction anymore.
3138 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3139 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3140 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3141 // technically disallowed and we should probably handle it reasonably.
3142 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3143 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3145 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3146 // commitment_signed (implying it will be in the latest remote commitment transaction).
3147 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3148 // and once they revoke the previous commitment transaction (allowing us to send a new
3149 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3150 let chanmon_cfgs = create_chanmon_cfgs(3);
3151 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3152 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3153 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3155 // Create some initial channels
3156 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3157 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3159 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3160 // Get the will-be-revoked local txn from nodes[2]
3161 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3162 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3163 // Revoke the old state
3164 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3166 let value = if use_dust {
3167 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3168 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3169 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3172 let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3173 let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3174 let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3176 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3177 expect_pending_htlcs_forwardable!(nodes[2]);
3178 check_added_monitors!(nodes[2], 1);
3179 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3180 assert!(updates.update_add_htlcs.is_empty());
3181 assert!(updates.update_fulfill_htlcs.is_empty());
3182 assert!(updates.update_fail_malformed_htlcs.is_empty());
3183 assert_eq!(updates.update_fail_htlcs.len(), 1);
3184 assert!(updates.update_fee.is_none());
3185 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3186 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3187 // Drop the last RAA from 3 -> 2
3189 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3190 expect_pending_htlcs_forwardable!(nodes[2]);
3191 check_added_monitors!(nodes[2], 1);
3192 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3193 assert!(updates.update_add_htlcs.is_empty());
3194 assert!(updates.update_fulfill_htlcs.is_empty());
3195 assert!(updates.update_fail_malformed_htlcs.is_empty());
3196 assert_eq!(updates.update_fail_htlcs.len(), 1);
3197 assert!(updates.update_fee.is_none());
3198 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3199 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3200 check_added_monitors!(nodes[1], 1);
3201 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3202 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3203 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3204 check_added_monitors!(nodes[2], 1);
3206 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3207 expect_pending_htlcs_forwardable!(nodes[2]);
3208 check_added_monitors!(nodes[2], 1);
3209 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3210 assert!(updates.update_add_htlcs.is_empty());
3211 assert!(updates.update_fulfill_htlcs.is_empty());
3212 assert!(updates.update_fail_malformed_htlcs.is_empty());
3213 assert_eq!(updates.update_fail_htlcs.len(), 1);
3214 assert!(updates.update_fee.is_none());
3215 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3216 // At this point first_payment_hash has dropped out of the latest two commitment
3217 // transactions that nodes[1] is tracking...
3218 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3219 check_added_monitors!(nodes[1], 1);
3220 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3221 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3222 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3223 check_added_monitors!(nodes[2], 1);
3225 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3226 // on nodes[2]'s RAA.
3227 let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3228 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3229 let logger = test_utils::TestLogger::new();
3230 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3231 nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3232 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3233 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3234 check_added_monitors!(nodes[1], 0);
3237 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3238 // One monitor for the new revocation preimage, no second on as we won't generate a new
3239 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3240 check_added_monitors!(nodes[1], 1);
3241 let events = nodes[1].node.get_and_clear_pending_events();
3242 assert_eq!(events.len(), 1);
3244 Event::PendingHTLCsForwardable { .. } => { },
3245 _ => panic!("Unexpected event"),
3247 // Deliberately don't process the pending fail-back so they all fail back at once after
3248 // block connection just like the !deliver_bs_raa case
3251 let mut failed_htlcs = HashSet::new();
3252 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3254 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3255 check_added_monitors!(nodes[1], 1);
3256 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3258 let events = nodes[1].node.get_and_clear_pending_events();
3259 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3261 Event::PaymentFailed { ref payment_hash, .. } => {
3262 assert_eq!(*payment_hash, fourth_payment_hash);
3264 _ => panic!("Unexpected event"),
3266 if !deliver_bs_raa {
3268 Event::PendingHTLCsForwardable { .. } => { },
3269 _ => panic!("Unexpected event"),
3272 nodes[1].node.process_pending_htlc_forwards();
3273 check_added_monitors!(nodes[1], 1);
3275 let events = nodes[1].node.get_and_clear_pending_msg_events();
3276 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3277 match events[if deliver_bs_raa { 1 } else { 0 }] {
3278 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3279 _ => panic!("Unexpected event"),
3281 match events[if deliver_bs_raa { 2 } else { 1 }] {
3282 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3283 assert_eq!(channel_id, chan_2.2);
3284 assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3286 _ => panic!("Unexpected event"),
3290 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, .. } } => {
3291 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3292 assert_eq!(update_add_htlcs.len(), 1);
3293 assert!(update_fulfill_htlcs.is_empty());
3294 assert!(update_fail_htlcs.is_empty());
3295 assert!(update_fail_malformed_htlcs.is_empty());
3297 _ => panic!("Unexpected event"),
3300 match events[if deliver_bs_raa { 3 } else { 2 }] {
3301 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, .. } } => {
3302 assert!(update_add_htlcs.is_empty());
3303 assert_eq!(update_fail_htlcs.len(), 3);
3304 assert!(update_fulfill_htlcs.is_empty());
3305 assert!(update_fail_malformed_htlcs.is_empty());
3306 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3308 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3309 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3310 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3312 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3314 let events = nodes[0].node.get_and_clear_pending_msg_events();
3315 // If we delivered B's RAA we got an unknown preimage error, not something
3316 // that we should update our routing table for.
3317 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3318 for event in events {
3320 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3321 _ => panic!("Unexpected event"),
3324 let events = nodes[0].node.get_and_clear_pending_events();
3325 assert_eq!(events.len(), 3);
3327 Event::PaymentFailed { ref payment_hash, .. } => {
3328 assert!(failed_htlcs.insert(payment_hash.0));
3330 _ => panic!("Unexpected event"),
3333 Event::PaymentFailed { ref payment_hash, .. } => {
3334 assert!(failed_htlcs.insert(payment_hash.0));
3336 _ => panic!("Unexpected event"),
3339 Event::PaymentFailed { ref payment_hash, .. } => {
3340 assert!(failed_htlcs.insert(payment_hash.0));
3342 _ => panic!("Unexpected event"),
3345 _ => panic!("Unexpected event"),
3348 assert!(failed_htlcs.contains(&first_payment_hash.0));
3349 assert!(failed_htlcs.contains(&second_payment_hash.0));
3350 assert!(failed_htlcs.contains(&third_payment_hash.0));
3354 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3355 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3356 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3357 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3358 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3362 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3363 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3364 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3365 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3366 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3370 fn fail_backward_pending_htlc_upon_channel_failure() {
3371 let chanmon_cfgs = create_chanmon_cfgs(2);
3372 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3373 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3374 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3375 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3376 let logger = test_utils::TestLogger::new();
3378 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3380 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3381 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3382 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3383 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3384 check_added_monitors!(nodes[0], 1);
3386 let payment_event = {
3387 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3388 assert_eq!(events.len(), 1);
3389 SendEvent::from_event(events.remove(0))
3391 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3392 assert_eq!(payment_event.msgs.len(), 1);
3395 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3396 let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3398 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3399 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3400 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3401 check_added_monitors!(nodes[0], 0);
3403 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3406 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3408 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3410 let secp_ctx = Secp256k1::new();
3411 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3412 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3413 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3414 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3415 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3416 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3417 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3419 // Send a 0-msat update_add_htlc to fail the channel.
3420 let update_add_htlc = msgs::UpdateAddHTLC {
3426 onion_routing_packet,
3428 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3431 // Check that Alice fails backward the pending HTLC from the second payment.
3432 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3433 check_closed_broadcast!(nodes[0], true);
3434 check_added_monitors!(nodes[0], 1);
3438 fn test_htlc_ignore_latest_remote_commitment() {
3439 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3440 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3441 let chanmon_cfgs = create_chanmon_cfgs(2);
3442 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3443 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3444 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3445 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3447 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3448 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3449 check_closed_broadcast!(nodes[0], true);
3450 check_added_monitors!(nodes[0], 1);
3452 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3453 assert_eq!(node_txn.len(), 2);
3455 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3456 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3457 check_closed_broadcast!(nodes[1], true);
3458 check_added_monitors!(nodes[1], 1);
3460 // Duplicate the connect_block call since this may happen due to other listeners
3461 // registering new transactions
3462 header.prev_blockhash = header.block_hash();
3463 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3467 fn test_force_close_fail_back() {
3468 // Check which HTLCs are failed-backwards on channel force-closure
3469 let chanmon_cfgs = create_chanmon_cfgs(3);
3470 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3471 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3472 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3473 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3474 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3475 let logger = test_utils::TestLogger::new();
3477 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3479 let mut payment_event = {
3480 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3481 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 1000000, 42, &logger).unwrap();
3482 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3483 check_added_monitors!(nodes[0], 1);
3485 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3486 assert_eq!(events.len(), 1);
3487 SendEvent::from_event(events.remove(0))
3490 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3491 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3493 expect_pending_htlcs_forwardable!(nodes[1]);
3495 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3496 assert_eq!(events_2.len(), 1);
3497 payment_event = SendEvent::from_event(events_2.remove(0));
3498 assert_eq!(payment_event.msgs.len(), 1);
3500 check_added_monitors!(nodes[1], 1);
3501 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3502 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3503 check_added_monitors!(nodes[2], 1);
3504 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3506 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3507 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3508 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3510 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3511 check_closed_broadcast!(nodes[2], true);
3512 check_added_monitors!(nodes[2], 1);
3514 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3515 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3516 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3517 // back to nodes[1] upon timeout otherwise.
3518 assert_eq!(node_txn.len(), 1);
3522 mine_transaction(&nodes[1], &tx);
3524 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3525 check_closed_broadcast!(nodes[1], true);
3526 check_added_monitors!(nodes[1], 1);
3528 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3530 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3531 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3532 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3534 mine_transaction(&nodes[2], &tx);
3535 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3536 assert_eq!(node_txn.len(), 1);
3537 assert_eq!(node_txn[0].input.len(), 1);
3538 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3539 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3540 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3542 check_spends!(node_txn[0], tx);
3546 fn test_simple_peer_disconnect() {
3547 // Test that we can reconnect when there are no lost messages
3548 let chanmon_cfgs = create_chanmon_cfgs(3);
3549 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3550 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3551 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3552 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3553 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3555 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3556 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3557 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3559 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3560 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3561 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3562 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3564 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3565 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3566 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3568 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3569 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3570 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3571 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3573 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3574 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3576 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3577 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3579 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3581 let events = nodes[0].node.get_and_clear_pending_events();
3582 assert_eq!(events.len(), 2);
3584 Event::PaymentSent { payment_preimage } => {
3585 assert_eq!(payment_preimage, payment_preimage_3);
3587 _ => panic!("Unexpected event"),
3590 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3591 assert_eq!(payment_hash, payment_hash_5);
3592 assert!(rejected_by_dest);
3594 _ => panic!("Unexpected event"),
3598 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3599 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3602 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3603 // Test that we can reconnect when in-flight HTLC updates get dropped
3604 let chanmon_cfgs = create_chanmon_cfgs(2);
3605 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3606 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3607 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3608 if messages_delivered == 0 {
3609 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3610 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3612 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3615 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3617 let logger = test_utils::TestLogger::new();
3618 let payment_event = {
3619 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3620 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3621 &nodes[1].node.get_our_node_id(), None, Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3622 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3623 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3624 check_added_monitors!(nodes[0], 1);
3626 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3627 assert_eq!(events.len(), 1);
3628 SendEvent::from_event(events.remove(0))
3630 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3632 if messages_delivered < 2 {
3633 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3635 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3636 if messages_delivered >= 3 {
3637 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3638 check_added_monitors!(nodes[1], 1);
3639 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3641 if messages_delivered >= 4 {
3642 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3643 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3644 check_added_monitors!(nodes[0], 1);
3646 if messages_delivered >= 5 {
3647 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3648 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3649 // No commitment_signed so get_event_msg's assert(len == 1) passes
3650 check_added_monitors!(nodes[0], 1);
3652 if messages_delivered >= 6 {
3653 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3654 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3655 check_added_monitors!(nodes[1], 1);
3662 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3663 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3664 if messages_delivered < 3 {
3665 // Even if the funding_locked messages get exchanged, as long as nothing further was
3666 // received on either side, both sides will need to resend them.
3667 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3668 } else if messages_delivered == 3 {
3669 // nodes[0] still wants its RAA + commitment_signed
3670 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3671 } else if messages_delivered == 4 {
3672 // nodes[0] still wants its commitment_signed
3673 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3674 } else if messages_delivered == 5 {
3675 // nodes[1] still wants its final RAA
3676 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3677 } else if messages_delivered == 6 {
3678 // Everything was delivered...
3679 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3682 let events_1 = nodes[1].node.get_and_clear_pending_events();
3683 assert_eq!(events_1.len(), 1);
3685 Event::PendingHTLCsForwardable { .. } => { },
3686 _ => panic!("Unexpected event"),
3689 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3690 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3691 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3693 nodes[1].node.process_pending_htlc_forwards();
3695 let events_2 = nodes[1].node.get_and_clear_pending_events();
3696 assert_eq!(events_2.len(), 1);
3698 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3699 assert_eq!(payment_hash_1, *payment_hash);
3700 assert_eq!(*payment_secret, None);
3701 assert_eq!(amt, 1000000);
3703 _ => panic!("Unexpected event"),
3706 nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3707 check_added_monitors!(nodes[1], 1);
3709 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3710 assert_eq!(events_3.len(), 1);
3711 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3712 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3713 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3714 assert!(updates.update_add_htlcs.is_empty());
3715 assert!(updates.update_fail_htlcs.is_empty());
3716 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3717 assert!(updates.update_fail_malformed_htlcs.is_empty());
3718 assert!(updates.update_fee.is_none());
3719 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3721 _ => panic!("Unexpected event"),
3724 if messages_delivered >= 1 {
3725 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3727 let events_4 = nodes[0].node.get_and_clear_pending_events();
3728 assert_eq!(events_4.len(), 1);
3730 Event::PaymentSent { ref payment_preimage } => {
3731 assert_eq!(payment_preimage_1, *payment_preimage);
3733 _ => panic!("Unexpected event"),
3736 if messages_delivered >= 2 {
3737 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3738 check_added_monitors!(nodes[0], 1);
3739 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3741 if messages_delivered >= 3 {
3742 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3743 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3744 check_added_monitors!(nodes[1], 1);
3746 if messages_delivered >= 4 {
3747 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3748 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3749 // No commitment_signed so get_event_msg's assert(len == 1) passes
3750 check_added_monitors!(nodes[1], 1);
3752 if messages_delivered >= 5 {
3753 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3754 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3755 check_added_monitors!(nodes[0], 1);
3762 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3763 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3764 if messages_delivered < 2 {
3765 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3766 //TODO: Deduplicate PaymentSent events, then enable this if:
3767 //if messages_delivered < 1 {
3768 let events_4 = nodes[0].node.get_and_clear_pending_events();
3769 assert_eq!(events_4.len(), 1);
3771 Event::PaymentSent { ref payment_preimage } => {
3772 assert_eq!(payment_preimage_1, *payment_preimage);
3774 _ => panic!("Unexpected event"),
3777 } else if messages_delivered == 2 {
3778 // nodes[0] still wants its RAA + commitment_signed
3779 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3780 } else if messages_delivered == 3 {
3781 // nodes[0] still wants its commitment_signed
3782 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3783 } else if messages_delivered == 4 {
3784 // nodes[1] still wants its final RAA
3785 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3786 } else if messages_delivered == 5 {
3787 // Everything was delivered...
3788 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3791 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3792 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3793 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3795 // Channel should still work fine...
3796 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3797 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3798 &nodes[1].node.get_our_node_id(), None, Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3799 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3800 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3801 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3805 fn test_drop_messages_peer_disconnect_a() {
3806 do_test_drop_messages_peer_disconnect(0);
3807 do_test_drop_messages_peer_disconnect(1);
3808 do_test_drop_messages_peer_disconnect(2);
3809 do_test_drop_messages_peer_disconnect(3);
3813 fn test_drop_messages_peer_disconnect_b() {
3814 do_test_drop_messages_peer_disconnect(4);
3815 do_test_drop_messages_peer_disconnect(5);
3816 do_test_drop_messages_peer_disconnect(6);
3820 fn test_funding_peer_disconnect() {
3821 // Test that we can lock in our funding tx while disconnected
3822 let chanmon_cfgs = create_chanmon_cfgs(2);
3823 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3824 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3825 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3826 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3828 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3829 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3831 confirm_transaction(&nodes[0], &tx);
3832 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3833 assert_eq!(events_1.len(), 1);
3835 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3836 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3838 _ => panic!("Unexpected event"),
3841 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3843 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3844 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3846 confirm_transaction(&nodes[1], &tx);
3847 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3848 assert_eq!(events_2.len(), 2);
3849 let funding_locked = match events_2[0] {
3850 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3851 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3854 _ => panic!("Unexpected event"),
3856 let bs_announcement_sigs = match events_2[1] {
3857 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3858 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3861 _ => panic!("Unexpected event"),
3864 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3866 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3867 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3868 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3869 assert_eq!(events_3.len(), 2);
3870 let as_announcement_sigs = match events_3[0] {
3871 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3872 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3875 _ => panic!("Unexpected event"),
3877 let (as_announcement, as_update) = match events_3[1] {
3878 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3879 (msg.clone(), update_msg.clone())
3881 _ => panic!("Unexpected event"),
3884 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3885 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3886 assert_eq!(events_4.len(), 1);
3887 let (_, bs_update) = match events_4[0] {
3888 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3889 (msg.clone(), update_msg.clone())
3891 _ => panic!("Unexpected event"),
3894 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3895 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3896 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3898 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3899 let logger = test_utils::TestLogger::new();
3900 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3901 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3902 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3906 fn test_drop_messages_peer_disconnect_dual_htlc() {
3907 // Test that we can handle reconnecting when both sides of a channel have pending
3908 // commitment_updates when we disconnect.
3909 let chanmon_cfgs = create_chanmon_cfgs(2);
3910 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3911 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3912 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3913 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3914 let logger = test_utils::TestLogger::new();
3916 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3918 // Now try to send a second payment which will fail to send
3919 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3920 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3921 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3922 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3923 check_added_monitors!(nodes[0], 1);
3925 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3926 assert_eq!(events_1.len(), 1);
3928 MessageSendEvent::UpdateHTLCs { .. } => {},
3929 _ => panic!("Unexpected event"),
3932 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3933 check_added_monitors!(nodes[1], 1);
3935 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3936 assert_eq!(events_2.len(), 1);
3938 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 } } => {
3939 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3940 assert!(update_add_htlcs.is_empty());
3941 assert_eq!(update_fulfill_htlcs.len(), 1);
3942 assert!(update_fail_htlcs.is_empty());
3943 assert!(update_fail_malformed_htlcs.is_empty());
3944 assert!(update_fee.is_none());
3946 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3947 let events_3 = nodes[0].node.get_and_clear_pending_events();
3948 assert_eq!(events_3.len(), 1);
3950 Event::PaymentSent { ref payment_preimage } => {
3951 assert_eq!(*payment_preimage, payment_preimage_1);
3953 _ => panic!("Unexpected event"),
3956 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3957 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3958 // No commitment_signed so get_event_msg's assert(len == 1) passes
3959 check_added_monitors!(nodes[0], 1);
3961 _ => panic!("Unexpected event"),
3964 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3965 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3967 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3968 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3969 assert_eq!(reestablish_1.len(), 1);
3970 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3971 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3972 assert_eq!(reestablish_2.len(), 1);
3974 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3975 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3976 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3977 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3979 assert!(as_resp.0.is_none());
3980 assert!(bs_resp.0.is_none());
3982 assert!(bs_resp.1.is_none());
3983 assert!(bs_resp.2.is_none());
3985 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3987 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3988 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3989 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3990 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3991 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3992 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3993 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3994 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3995 // No commitment_signed so get_event_msg's assert(len == 1) passes
3996 check_added_monitors!(nodes[1], 1);
3998 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3999 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4000 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4001 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4002 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4003 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4004 assert!(bs_second_commitment_signed.update_fee.is_none());
4005 check_added_monitors!(nodes[1], 1);
4007 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4008 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4009 assert!(as_commitment_signed.update_add_htlcs.is_empty());
4010 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4011 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4012 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4013 assert!(as_commitment_signed.update_fee.is_none());
4014 check_added_monitors!(nodes[0], 1);
4016 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4017 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4018 // No commitment_signed so get_event_msg's assert(len == 1) passes
4019 check_added_monitors!(nodes[0], 1);
4021 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4022 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4023 // No commitment_signed so get_event_msg's assert(len == 1) passes
4024 check_added_monitors!(nodes[1], 1);
4026 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4027 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4028 check_added_monitors!(nodes[1], 1);
4030 expect_pending_htlcs_forwardable!(nodes[1]);
4032 let events_5 = nodes[1].node.get_and_clear_pending_events();
4033 assert_eq!(events_5.len(), 1);
4035 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
4036 assert_eq!(payment_hash_2, *payment_hash);
4037 assert_eq!(*payment_secret, None);
4039 _ => panic!("Unexpected event"),
4042 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4043 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4044 check_added_monitors!(nodes[0], 1);
4046 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
4049 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4050 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4051 // to avoid our counterparty failing the channel.
4052 let chanmon_cfgs = create_chanmon_cfgs(2);
4053 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4054 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4055 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4057 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4058 let logger = test_utils::TestLogger::new();
4060 let our_payment_hash = if send_partial_mpp {
4061 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4062 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4063 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4064 let payment_secret = PaymentSecret([0xdb; 32]);
4065 // Use the utility function send_payment_along_path to send the payment with MPP data which
4066 // indicates there are more HTLCs coming.
4067 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.
4068 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4069 check_added_monitors!(nodes[0], 1);
4070 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4071 assert_eq!(events.len(), 1);
4072 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4073 // hop should *not* yet generate any PaymentReceived event(s).
4074 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4077 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4080 let mut block = Block {
4081 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4084 connect_block(&nodes[0], &block);
4085 connect_block(&nodes[1], &block);
4086 for _ in CHAN_CONFIRM_DEPTH + 2 ..TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4087 block.header.prev_blockhash = block.block_hash();
4088 connect_block(&nodes[0], &block);
4089 connect_block(&nodes[1], &block);
4092 expect_pending_htlcs_forwardable!(nodes[1]);
4094 check_added_monitors!(nodes[1], 1);
4095 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4096 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4097 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4098 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4099 assert!(htlc_timeout_updates.update_fee.is_none());
4101 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4102 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4103 // 100_000 msat as u64, followed by a height of TEST_FINAL_CLTV + 2 as u32
4104 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4105 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(TEST_FINAL_CLTV + 2));
4106 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4110 fn test_htlc_timeout() {
4111 do_test_htlc_timeout(true);
4112 do_test_htlc_timeout(false);
4115 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4116 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4117 let chanmon_cfgs = create_chanmon_cfgs(3);
4118 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4119 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4120 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4121 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4122 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4124 // Make sure all nodes are at the same starting height
4125 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4126 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4127 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4129 let logger = test_utils::TestLogger::new();
4131 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4132 let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4134 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4135 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4136 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4138 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4139 check_added_monitors!(nodes[1], 1);
4141 // Now attempt to route a second payment, which should be placed in the holding cell
4142 let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4144 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4145 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4146 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4147 check_added_monitors!(nodes[0], 1);
4148 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4149 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4150 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4151 expect_pending_htlcs_forwardable!(nodes[1]);
4152 check_added_monitors!(nodes[1], 0);
4154 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4155 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4156 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4157 check_added_monitors!(nodes[1], 0);
4160 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4161 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4162 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4163 connect_blocks(&nodes[1], 1);
4166 expect_pending_htlcs_forwardable!(nodes[1]);
4167 check_added_monitors!(nodes[1], 1);
4168 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4169 assert_eq!(fail_commit.len(), 1);
4170 match fail_commit[0] {
4171 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4172 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4173 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4175 _ => unreachable!(),
4177 expect_payment_failed!(nodes[0], second_payment_hash, false);
4178 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4180 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4181 _ => panic!("Unexpected event"),
4184 panic!("Unexpected event");
4187 expect_payment_failed!(nodes[1], second_payment_hash, true);
4192 fn test_holding_cell_htlc_add_timeouts() {
4193 do_test_holding_cell_htlc_add_timeouts(false);
4194 do_test_holding_cell_htlc_add_timeouts(true);
4198 fn test_invalid_channel_announcement() {
4199 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4200 let secp_ctx = Secp256k1::new();
4201 let chanmon_cfgs = create_chanmon_cfgs(2);
4202 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4203 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4204 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4206 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4208 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4209 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4210 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4211 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4213 nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4215 let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4216 let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4218 let as_network_key = nodes[0].node.get_our_node_id();
4219 let bs_network_key = nodes[1].node.get_our_node_id();
4221 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4223 let mut chan_announcement;
4225 macro_rules! dummy_unsigned_msg {
4227 msgs::UnsignedChannelAnnouncement {
4228 features: ChannelFeatures::known(),
4229 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4230 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4231 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4232 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4233 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4234 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4235 excess_data: Vec::new(),
4240 macro_rules! sign_msg {
4241 ($unsigned_msg: expr) => {
4242 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4243 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4244 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4245 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4246 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4247 chan_announcement = msgs::ChannelAnnouncement {
4248 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4249 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4250 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4251 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4252 contents: $unsigned_msg
4257 let unsigned_msg = dummy_unsigned_msg!();
4258 sign_msg!(unsigned_msg);
4259 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4260 let _ = nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4262 // Configured with Network::Testnet
4263 let mut unsigned_msg = dummy_unsigned_msg!();
4264 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4265 sign_msg!(unsigned_msg);
4266 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4268 let mut unsigned_msg = dummy_unsigned_msg!();
4269 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4270 sign_msg!(unsigned_msg);
4271 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4275 fn test_no_txn_manager_serialize_deserialize() {
4276 let chanmon_cfgs = create_chanmon_cfgs(2);
4277 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4278 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4279 let logger: test_utils::TestLogger;
4280 let fee_estimator: test_utils::TestFeeEstimator;
4281 let persister: test_utils::TestPersister;
4282 let new_chain_monitor: test_utils::TestChainMonitor;
4283 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4284 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4286 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4288 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4290 let nodes_0_serialized = nodes[0].node.encode();
4291 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4292 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4294 logger = test_utils::TestLogger::new();
4295 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4296 persister = test_utils::TestPersister::new();
4297 let keys_manager = &chanmon_cfgs[0].keys_manager;
4298 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4299 nodes[0].chain_monitor = &new_chain_monitor;
4300 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4301 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4302 &mut chan_0_monitor_read, keys_manager).unwrap();
4303 assert!(chan_0_monitor_read.is_empty());
4305 let mut nodes_0_read = &nodes_0_serialized[..];
4306 let config = UserConfig::default();
4307 let (_, nodes_0_deserialized_tmp) = {
4308 let mut channel_monitors = HashMap::new();
4309 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4310 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4311 default_config: config,
4313 fee_estimator: &fee_estimator,
4314 chain_monitor: nodes[0].chain_monitor,
4315 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4320 nodes_0_deserialized = nodes_0_deserialized_tmp;
4321 assert!(nodes_0_read.is_empty());
4323 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4324 nodes[0].node = &nodes_0_deserialized;
4325 assert_eq!(nodes[0].node.list_channels().len(), 1);
4326 check_added_monitors!(nodes[0], 1);
4328 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4329 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4330 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4331 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4333 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4334 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4335 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4336 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4338 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4339 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4340 for node in nodes.iter() {
4341 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4342 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4343 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4346 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4350 fn test_manager_serialize_deserialize_events() {
4351 // This test makes sure the events field in ChannelManager survives de/serialization
4352 let chanmon_cfgs = create_chanmon_cfgs(2);
4353 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4354 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4355 let fee_estimator: test_utils::TestFeeEstimator;
4356 let persister: test_utils::TestPersister;
4357 let logger: test_utils::TestLogger;
4358 let new_chain_monitor: test_utils::TestChainMonitor;
4359 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4360 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4362 // Start creating a channel, but stop right before broadcasting the funding transaction
4363 let channel_value = 100000;
4364 let push_msat = 10001;
4365 let a_flags = InitFeatures::known();
4366 let b_flags = InitFeatures::known();
4367 let node_a = nodes.remove(0);
4368 let node_b = nodes.remove(0);
4369 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4370 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()));
4371 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()));
4373 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4375 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4376 check_added_monitors!(node_a, 0);
4378 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()));
4380 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4381 assert_eq!(added_monitors.len(), 1);
4382 assert_eq!(added_monitors[0].0, funding_output);
4383 added_monitors.clear();
4386 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()));
4388 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4389 assert_eq!(added_monitors.len(), 1);
4390 assert_eq!(added_monitors[0].0, funding_output);
4391 added_monitors.clear();
4393 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4398 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4399 let nodes_0_serialized = nodes[0].node.encode();
4400 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4401 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4403 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4404 logger = test_utils::TestLogger::new();
4405 persister = test_utils::TestPersister::new();
4406 let keys_manager = &chanmon_cfgs[0].keys_manager;
4407 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4408 nodes[0].chain_monitor = &new_chain_monitor;
4409 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4410 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4411 &mut chan_0_monitor_read, keys_manager).unwrap();
4412 assert!(chan_0_monitor_read.is_empty());
4414 let mut nodes_0_read = &nodes_0_serialized[..];
4415 let config = UserConfig::default();
4416 let (_, nodes_0_deserialized_tmp) = {
4417 let mut channel_monitors = HashMap::new();
4418 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4419 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4420 default_config: config,
4422 fee_estimator: &fee_estimator,
4423 chain_monitor: nodes[0].chain_monitor,
4424 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4429 nodes_0_deserialized = nodes_0_deserialized_tmp;
4430 assert!(nodes_0_read.is_empty());
4432 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4434 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4435 nodes[0].node = &nodes_0_deserialized;
4437 // After deserializing, make sure the funding_transaction is still held by the channel manager
4438 let events_4 = nodes[0].node.get_and_clear_pending_events();
4439 assert_eq!(events_4.len(), 0);
4440 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4441 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4443 // Make sure the channel is functioning as though the de/serialization never happened
4444 assert_eq!(nodes[0].node.list_channels().len(), 1);
4445 check_added_monitors!(nodes[0], 1);
4447 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4448 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4449 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4450 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4452 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4453 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4454 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4455 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4457 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4458 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4459 for node in nodes.iter() {
4460 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4461 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4462 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4465 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4469 fn test_simple_manager_serialize_deserialize() {
4470 let chanmon_cfgs = create_chanmon_cfgs(2);
4471 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4472 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4473 let logger: test_utils::TestLogger;
4474 let fee_estimator: test_utils::TestFeeEstimator;
4475 let persister: test_utils::TestPersister;
4476 let new_chain_monitor: test_utils::TestChainMonitor;
4477 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4478 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4479 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4481 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4482 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4484 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4486 let nodes_0_serialized = nodes[0].node.encode();
4487 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4488 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4490 logger = test_utils::TestLogger::new();
4491 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4492 persister = test_utils::TestPersister::new();
4493 let keys_manager = &chanmon_cfgs[0].keys_manager;
4494 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4495 nodes[0].chain_monitor = &new_chain_monitor;
4496 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4497 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4498 &mut chan_0_monitor_read, keys_manager).unwrap();
4499 assert!(chan_0_monitor_read.is_empty());
4501 let mut nodes_0_read = &nodes_0_serialized[..];
4502 let (_, nodes_0_deserialized_tmp) = {
4503 let mut channel_monitors = HashMap::new();
4504 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4505 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4506 default_config: UserConfig::default(),
4508 fee_estimator: &fee_estimator,
4509 chain_monitor: nodes[0].chain_monitor,
4510 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4515 nodes_0_deserialized = nodes_0_deserialized_tmp;
4516 assert!(nodes_0_read.is_empty());
4518 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4519 nodes[0].node = &nodes_0_deserialized;
4520 check_added_monitors!(nodes[0], 1);
4522 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4524 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4525 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4529 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4530 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4531 let chanmon_cfgs = create_chanmon_cfgs(4);
4532 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4533 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4534 let logger: test_utils::TestLogger;
4535 let fee_estimator: test_utils::TestFeeEstimator;
4536 let persister: test_utils::TestPersister;
4537 let new_chain_monitor: test_utils::TestChainMonitor;
4538 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4539 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4540 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4541 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4542 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4544 let mut node_0_stale_monitors_serialized = Vec::new();
4545 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4546 let mut writer = test_utils::TestVecWriter(Vec::new());
4547 monitor.1.write(&mut writer).unwrap();
4548 node_0_stale_monitors_serialized.push(writer.0);
4551 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4553 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4554 let nodes_0_serialized = nodes[0].node.encode();
4556 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4557 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4558 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4559 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4561 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4563 let mut node_0_monitors_serialized = Vec::new();
4564 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4565 let mut writer = test_utils::TestVecWriter(Vec::new());
4566 monitor.1.write(&mut writer).unwrap();
4567 node_0_monitors_serialized.push(writer.0);
4570 logger = test_utils::TestLogger::new();
4571 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4572 persister = test_utils::TestPersister::new();
4573 let keys_manager = &chanmon_cfgs[0].keys_manager;
4574 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4575 nodes[0].chain_monitor = &new_chain_monitor;
4578 let mut node_0_stale_monitors = Vec::new();
4579 for serialized in node_0_stale_monitors_serialized.iter() {
4580 let mut read = &serialized[..];
4581 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4582 assert!(read.is_empty());
4583 node_0_stale_monitors.push(monitor);
4586 let mut node_0_monitors = Vec::new();
4587 for serialized in node_0_monitors_serialized.iter() {
4588 let mut read = &serialized[..];
4589 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4590 assert!(read.is_empty());
4591 node_0_monitors.push(monitor);
4594 let mut nodes_0_read = &nodes_0_serialized[..];
4595 if let Err(msgs::DecodeError::InvalidValue) =
4596 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4597 default_config: UserConfig::default(),
4599 fee_estimator: &fee_estimator,
4600 chain_monitor: nodes[0].chain_monitor,
4601 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4603 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4605 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4608 let mut nodes_0_read = &nodes_0_serialized[..];
4609 let (_, nodes_0_deserialized_tmp) =
4610 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4611 default_config: UserConfig::default(),
4613 fee_estimator: &fee_estimator,
4614 chain_monitor: nodes[0].chain_monitor,
4615 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4617 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4619 nodes_0_deserialized = nodes_0_deserialized_tmp;
4620 assert!(nodes_0_read.is_empty());
4622 { // Channel close should result in a commitment tx and an HTLC tx
4623 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4624 assert_eq!(txn.len(), 2);
4625 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4626 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4629 for monitor in node_0_monitors.drain(..) {
4630 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4631 check_added_monitors!(nodes[0], 1);
4633 nodes[0].node = &nodes_0_deserialized;
4635 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4636 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4637 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4638 //... and we can even still claim the payment!
4639 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4641 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4642 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4643 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4644 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4645 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4646 assert_eq!(msg_events.len(), 1);
4647 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4649 &ErrorAction::SendErrorMessage { ref msg } => {
4650 assert_eq!(msg.channel_id, channel_id);
4652 _ => panic!("Unexpected event!"),
4657 macro_rules! check_spendable_outputs {
4658 ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4660 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4661 let mut txn = Vec::new();
4662 let mut all_outputs = Vec::new();
4663 let secp_ctx = Secp256k1::new();
4664 for event in events.drain(..) {
4666 Event::SpendableOutputs { mut outputs } => {
4667 for outp in outputs.drain(..) {
4668 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4669 all_outputs.push(outp);
4672 _ => panic!("Unexpected event"),
4675 if all_outputs.len() > 1 {
4676 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) {
4686 fn test_claim_sizeable_push_msat() {
4687 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4688 let chanmon_cfgs = create_chanmon_cfgs(2);
4689 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4690 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4691 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4693 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4694 nodes[1].node.force_close_channel(&chan.2).unwrap();
4695 check_closed_broadcast!(nodes[1], true);
4696 check_added_monitors!(nodes[1], 1);
4697 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4698 assert_eq!(node_txn.len(), 1);
4699 check_spends!(node_txn[0], chan.3);
4700 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
4702 mine_transaction(&nodes[1], &node_txn[0]);
4703 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4705 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4706 assert_eq!(spend_txn.len(), 1);
4707 check_spends!(spend_txn[0], node_txn[0]);
4711 fn test_claim_on_remote_sizeable_push_msat() {
4712 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4713 // to_remote output is encumbered by a P2WPKH
4714 let chanmon_cfgs = create_chanmon_cfgs(2);
4715 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4716 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4717 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4719 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4720 nodes[0].node.force_close_channel(&chan.2).unwrap();
4721 check_closed_broadcast!(nodes[0], true);
4722 check_added_monitors!(nodes[0], 1);
4724 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4725 assert_eq!(node_txn.len(), 1);
4726 check_spends!(node_txn[0], chan.3);
4727 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
4729 mine_transaction(&nodes[1], &node_txn[0]);
4730 check_closed_broadcast!(nodes[1], true);
4731 check_added_monitors!(nodes[1], 1);
4732 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4734 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4735 assert_eq!(spend_txn.len(), 1);
4736 check_spends!(spend_txn[0], node_txn[0]);
4740 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4741 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4742 // to_remote output is encumbered by a P2WPKH
4744 let chanmon_cfgs = create_chanmon_cfgs(2);
4745 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4746 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4747 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4749 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4750 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4751 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4752 assert_eq!(revoked_local_txn[0].input.len(), 1);
4753 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4755 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4756 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4757 check_closed_broadcast!(nodes[1], true);
4758 check_added_monitors!(nodes[1], 1);
4760 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4761 mine_transaction(&nodes[1], &node_txn[0]);
4762 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4764 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4765 assert_eq!(spend_txn.len(), 3);
4766 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4767 check_spends!(spend_txn[1], node_txn[0]);
4768 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4772 fn test_static_spendable_outputs_preimage_tx() {
4773 let chanmon_cfgs = create_chanmon_cfgs(2);
4774 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4775 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4776 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4778 // Create some initial channels
4779 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4781 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4783 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4784 assert_eq!(commitment_tx[0].input.len(), 1);
4785 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4787 // Settle A's commitment tx on B's chain
4788 assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4789 check_added_monitors!(nodes[1], 1);
4790 mine_transaction(&nodes[1], &commitment_tx[0]);
4791 check_added_monitors!(nodes[1], 1);
4792 let events = nodes[1].node.get_and_clear_pending_msg_events();
4794 MessageSendEvent::UpdateHTLCs { .. } => {},
4795 _ => panic!("Unexpected event"),
4798 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4799 _ => panic!("Unexepected event"),
4802 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4803 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4804 assert_eq!(node_txn.len(), 3);
4805 check_spends!(node_txn[0], commitment_tx[0]);
4806 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4807 check_spends!(node_txn[1], chan_1.3);
4808 check_spends!(node_txn[2], node_txn[1]);
4810 mine_transaction(&nodes[1], &node_txn[0]);
4811 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4813 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4814 assert_eq!(spend_txn.len(), 1);
4815 check_spends!(spend_txn[0], node_txn[0]);
4819 fn test_static_spendable_outputs_timeout_tx() {
4820 let chanmon_cfgs = create_chanmon_cfgs(2);
4821 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4822 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4823 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4825 // Create some initial channels
4826 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4828 // Rebalance the network a bit by relaying one payment through all the channels ...
4829 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4831 let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4833 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4834 assert_eq!(commitment_tx[0].input.len(), 1);
4835 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4837 // Settle A's commitment tx on B' chain
4838 mine_transaction(&nodes[1], &commitment_tx[0]);
4839 check_added_monitors!(nodes[1], 1);
4840 let events = nodes[1].node.get_and_clear_pending_msg_events();
4842 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4843 _ => panic!("Unexpected event"),
4846 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4847 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4848 assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4849 check_spends!(node_txn[0], commitment_tx[0].clone());
4850 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4851 check_spends!(node_txn[1], chan_1.3.clone());
4852 check_spends!(node_txn[2], node_txn[1]);
4854 mine_transaction(&nodes[1], &node_txn[0]);
4855 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4856 expect_payment_failed!(nodes[1], our_payment_hash, true);
4858 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4859 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4860 check_spends!(spend_txn[0], commitment_tx[0]);
4861 check_spends!(spend_txn[1], node_txn[0]);
4862 check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
4866 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4867 let chanmon_cfgs = create_chanmon_cfgs(2);
4868 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4869 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4870 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4872 // Create some initial channels
4873 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4875 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4876 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4877 assert_eq!(revoked_local_txn[0].input.len(), 1);
4878 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4880 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4882 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4883 check_closed_broadcast!(nodes[1], true);
4884 check_added_monitors!(nodes[1], 1);
4886 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4887 assert_eq!(node_txn.len(), 2);
4888 assert_eq!(node_txn[0].input.len(), 2);
4889 check_spends!(node_txn[0], revoked_local_txn[0]);
4891 mine_transaction(&nodes[1], &node_txn[0]);
4892 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4894 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4895 assert_eq!(spend_txn.len(), 1);
4896 check_spends!(spend_txn[0], node_txn[0]);
4900 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4901 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4902 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4903 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4904 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4905 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4907 // Create some initial channels
4908 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4910 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4911 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4912 assert_eq!(revoked_local_txn[0].input.len(), 1);
4913 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4915 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4917 // A will generate HTLC-Timeout from revoked commitment tx
4918 mine_transaction(&nodes[0], &revoked_local_txn[0]);
4919 check_closed_broadcast!(nodes[0], true);
4920 check_added_monitors!(nodes[0], 1);
4922 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4923 assert_eq!(revoked_htlc_txn.len(), 2);
4924 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4925 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4926 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4927 check_spends!(revoked_htlc_txn[1], chan_1.3);
4929 // B will generate justice tx from A's revoked commitment/HTLC tx
4930 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4931 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4932 check_closed_broadcast!(nodes[1], true);
4933 check_added_monitors!(nodes[1], 1);
4935 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4936 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4937 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4938 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4939 // transactions next...
4940 assert_eq!(node_txn[0].input.len(), 3);
4941 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4943 assert_eq!(node_txn[1].input.len(), 2);
4944 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
4945 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4946 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4948 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4949 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4952 assert_eq!(node_txn[2].input.len(), 1);
4953 check_spends!(node_txn[2], chan_1.3);
4955 mine_transaction(&nodes[1], &node_txn[1]);
4956 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4958 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4959 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4960 assert_eq!(spend_txn.len(), 1);
4961 assert_eq!(spend_txn[0].input.len(), 1);
4962 check_spends!(spend_txn[0], node_txn[1]);
4966 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4967 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4968 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4969 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4970 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4971 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4973 // Create some initial channels
4974 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4976 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4977 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4978 assert_eq!(revoked_local_txn[0].input.len(), 1);
4979 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4981 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4982 assert_eq!(revoked_local_txn[0].output.len(), 2);
4984 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4986 // B will generate HTLC-Success from revoked commitment tx
4987 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4988 check_closed_broadcast!(nodes[1], true);
4989 check_added_monitors!(nodes[1], 1);
4990 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4992 assert_eq!(revoked_htlc_txn.len(), 2);
4993 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4994 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4995 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4997 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4998 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4999 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5001 // A will generate justice tx from B's revoked commitment/HTLC tx
5002 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5003 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5004 check_closed_broadcast!(nodes[0], true);
5005 check_added_monitors!(nodes[0], 1);
5007 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5008 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5010 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5011 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5012 // transactions next...
5013 assert_eq!(node_txn[0].input.len(), 2);
5014 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5015 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5016 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5018 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5019 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5022 assert_eq!(node_txn[1].input.len(), 1);
5023 check_spends!(node_txn[1], revoked_htlc_txn[0]);
5025 check_spends!(node_txn[2], chan_1.3);
5027 mine_transaction(&nodes[0], &node_txn[1]);
5028 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5030 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5031 // didn't try to generate any new transactions.
5033 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5034 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5035 assert_eq!(spend_txn.len(), 3);
5036 assert_eq!(spend_txn[0].input.len(), 1);
5037 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5038 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5039 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5040 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5044 fn test_onchain_to_onchain_claim() {
5045 // Test that in case of channel closure, we detect the state of output and claim HTLC
5046 // on downstream peer's remote commitment tx.
5047 // First, have C claim an HTLC against its own latest commitment transaction.
5048 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5050 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5053 let chanmon_cfgs = create_chanmon_cfgs(3);
5054 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5055 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5056 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5058 // Create some initial channels
5059 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5060 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5062 // Rebalance the network a bit by relaying one payment through all the channels ...
5063 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5064 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5066 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5067 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5068 check_spends!(commitment_tx[0], chan_2.3);
5069 nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5070 check_added_monitors!(nodes[2], 1);
5071 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5072 assert!(updates.update_add_htlcs.is_empty());
5073 assert!(updates.update_fail_htlcs.is_empty());
5074 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5075 assert!(updates.update_fail_malformed_htlcs.is_empty());
5077 mine_transaction(&nodes[2], &commitment_tx[0]);
5078 check_closed_broadcast!(nodes[2], true);
5079 check_added_monitors!(nodes[2], 1);
5081 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5082 assert_eq!(c_txn.len(), 3);
5083 assert_eq!(c_txn[0], c_txn[2]);
5084 assert_eq!(commitment_tx[0], c_txn[1]);
5085 check_spends!(c_txn[1], chan_2.3);
5086 check_spends!(c_txn[2], c_txn[1]);
5087 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5088 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5089 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5090 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5092 // 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
5093 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5094 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5096 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5097 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5098 assert_eq!(b_txn.len(), 3);
5099 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5100 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5101 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5102 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5103 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5104 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5105 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5106 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5107 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5110 check_added_monitors!(nodes[1], 1);
5111 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5112 assert_eq!(msg_events.len(), 3);
5113 check_added_monitors!(nodes[1], 1);
5114 match msg_events[0] {
5115 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5116 _ => panic!("Unexpected event"),
5118 match msg_events[1] {
5119 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5120 _ => panic!("Unexpected event"),
5122 match msg_events[2] {
5123 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, .. } } => {
5124 assert!(update_add_htlcs.is_empty());
5125 assert!(update_fail_htlcs.is_empty());
5126 assert_eq!(update_fulfill_htlcs.len(), 1);
5127 assert!(update_fail_malformed_htlcs.is_empty());
5128 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5130 _ => panic!("Unexpected event"),
5132 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5133 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5134 mine_transaction(&nodes[1], &commitment_tx[0]);
5135 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5136 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5137 assert_eq!(b_txn.len(), 3);
5138 check_spends!(b_txn[1], chan_1.3);
5139 check_spends!(b_txn[2], b_txn[1]);
5140 check_spends!(b_txn[0], commitment_tx[0]);
5141 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5142 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5143 assert_eq!(b_txn[0].lock_time, 0); // Success tx
5145 check_closed_broadcast!(nodes[1], true);
5146 check_added_monitors!(nodes[1], 1);
5150 fn test_duplicate_payment_hash_one_failure_one_success() {
5151 // Topology : A --> B --> C
5152 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5153 let chanmon_cfgs = create_chanmon_cfgs(3);
5154 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5155 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5156 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5158 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5159 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5161 let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5162 *nodes[0].network_payment_count.borrow_mut() -= 1;
5163 assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5165 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5166 assert_eq!(commitment_txn[0].input.len(), 1);
5167 check_spends!(commitment_txn[0], chan_2.3);
5169 mine_transaction(&nodes[1], &commitment_txn[0]);
5170 check_closed_broadcast!(nodes[1], true);
5171 check_added_monitors!(nodes[1], 1);
5173 let htlc_timeout_tx;
5174 { // Extract one of the two HTLC-Timeout transaction
5175 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5176 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5177 assert_eq!(node_txn.len(), 5);
5178 check_spends!(node_txn[0], commitment_txn[0]);
5179 assert_eq!(node_txn[0].input.len(), 1);
5180 check_spends!(node_txn[1], commitment_txn[0]);
5181 assert_eq!(node_txn[1].input.len(), 1);
5182 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5183 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5184 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5185 check_spends!(node_txn[2], chan_2.3);
5186 check_spends!(node_txn[3], node_txn[2]);
5187 check_spends!(node_txn[4], node_txn[2]);
5188 htlc_timeout_tx = node_txn[1].clone();
5191 nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5192 mine_transaction(&nodes[2], &commitment_txn[0]);
5193 check_added_monitors!(nodes[2], 3);
5194 let events = nodes[2].node.get_and_clear_pending_msg_events();
5196 MessageSendEvent::UpdateHTLCs { .. } => {},
5197 _ => panic!("Unexpected event"),
5200 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5201 _ => panic!("Unexepected event"),
5203 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5204 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)
5205 check_spends!(htlc_success_txn[2], chan_2.3);
5206 check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5207 check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5208 assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5209 assert_eq!(htlc_success_txn[0].input.len(), 1);
5210 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5211 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5212 assert_eq!(htlc_success_txn[1].input.len(), 1);
5213 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5214 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5215 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5216 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5218 mine_transaction(&nodes[1], &htlc_timeout_tx);
5219 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5220 expect_pending_htlcs_forwardable!(nodes[1]);
5221 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5222 assert!(htlc_updates.update_add_htlcs.is_empty());
5223 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5224 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5225 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5226 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5227 check_added_monitors!(nodes[1], 1);
5229 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5230 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5232 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5233 let events = nodes[0].node.get_and_clear_pending_msg_events();
5234 assert_eq!(events.len(), 1);
5236 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
5238 _ => { panic!("Unexpected event"); }
5241 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5243 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5244 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5245 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5246 assert!(updates.update_add_htlcs.is_empty());
5247 assert!(updates.update_fail_htlcs.is_empty());
5248 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5249 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5250 assert!(updates.update_fail_malformed_htlcs.is_empty());
5251 check_added_monitors!(nodes[1], 1);
5253 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5254 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5256 let events = nodes[0].node.get_and_clear_pending_events();
5258 Event::PaymentSent { ref payment_preimage } => {
5259 assert_eq!(*payment_preimage, our_payment_preimage);
5261 _ => panic!("Unexpected event"),
5266 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5267 let chanmon_cfgs = create_chanmon_cfgs(2);
5268 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5269 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5270 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5272 // Create some initial channels
5273 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5275 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5276 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5277 assert_eq!(local_txn.len(), 1);
5278 assert_eq!(local_txn[0].input.len(), 1);
5279 check_spends!(local_txn[0], chan_1.3);
5281 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5282 nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5283 check_added_monitors!(nodes[1], 1);
5284 mine_transaction(&nodes[1], &local_txn[0]);
5285 check_added_monitors!(nodes[1], 1);
5286 let events = nodes[1].node.get_and_clear_pending_msg_events();
5288 MessageSendEvent::UpdateHTLCs { .. } => {},
5289 _ => panic!("Unexpected event"),
5292 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5293 _ => panic!("Unexepected event"),
5296 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5297 assert_eq!(node_txn.len(), 3);
5298 assert_eq!(node_txn[0], node_txn[2]);
5299 assert_eq!(node_txn[1], local_txn[0]);
5300 assert_eq!(node_txn[0].input.len(), 1);
5301 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5302 check_spends!(node_txn[0], local_txn[0]);
5306 mine_transaction(&nodes[1], &node_tx);
5307 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5309 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5310 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5311 assert_eq!(spend_txn.len(), 1);
5312 check_spends!(spend_txn[0], node_tx);
5315 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5316 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5317 // unrevoked commitment transaction.
5318 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5319 // a remote RAA before they could be failed backwards (and combinations thereof).
5320 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5321 // use the same payment hashes.
5322 // Thus, we use a six-node network:
5327 // And test where C fails back to A/B when D announces its latest commitment transaction
5328 let chanmon_cfgs = create_chanmon_cfgs(6);
5329 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5330 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5331 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5332 let logger = test_utils::TestLogger::new();
5334 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5335 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5336 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5337 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5338 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5340 // Rebalance and check output sanity...
5341 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5342 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5343 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5345 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5347 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
5349 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
5350 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5351 let our_node_id = &nodes[1].node.get_our_node_id();
5352 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5354 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_1); // not added < dust limit + HTLC tx fee
5356 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_2); // not added < dust limit + HTLC tx fee
5358 let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5360 let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5361 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5363 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5365 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5368 let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5370 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5371 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_5); // not added < dust limit + HTLC tx fee
5374 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
5376 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5377 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5379 // Double-check that six of the new HTLC were added
5380 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5381 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5382 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5383 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5385 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5386 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5387 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5388 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5389 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5390 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5391 check_added_monitors!(nodes[4], 0);
5392 expect_pending_htlcs_forwardable!(nodes[4]);
5393 check_added_monitors!(nodes[4], 1);
5395 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5396 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5397 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5398 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5399 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5400 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5402 // Fail 3rd below-dust and 7th above-dust HTLCs
5403 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5404 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5405 check_added_monitors!(nodes[5], 0);
5406 expect_pending_htlcs_forwardable!(nodes[5]);
5407 check_added_monitors!(nodes[5], 1);
5409 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5410 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5411 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5412 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5414 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5416 expect_pending_htlcs_forwardable!(nodes[3]);
5417 check_added_monitors!(nodes[3], 1);
5418 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5419 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5420 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5421 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5422 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5423 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5424 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5425 if deliver_last_raa {
5426 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5428 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5431 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5432 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5433 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5434 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5436 // We now broadcast the latest commitment transaction, which *should* result in failures for
5437 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5438 // the non-broadcast above-dust HTLCs.
5440 // Alternatively, we may broadcast the previous commitment transaction, which should only
5441 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5442 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5444 if announce_latest {
5445 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5447 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5449 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5450 check_closed_broadcast!(nodes[2], true);
5451 expect_pending_htlcs_forwardable!(nodes[2]);
5452 check_added_monitors!(nodes[2], 3);
5454 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5455 assert_eq!(cs_msgs.len(), 2);
5456 let mut a_done = false;
5457 for msg in cs_msgs {
5459 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5460 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5461 // should be failed-backwards here.
5462 let target = if *node_id == nodes[0].node.get_our_node_id() {
5463 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5464 for htlc in &updates.update_fail_htlcs {
5465 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 });
5467 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5472 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5473 for htlc in &updates.update_fail_htlcs {
5474 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5476 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5477 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5480 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5481 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5482 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5483 if announce_latest {
5484 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5485 if *node_id == nodes[0].node.get_our_node_id() {
5486 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5489 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5491 _ => panic!("Unexpected event"),
5495 let as_events = nodes[0].node.get_and_clear_pending_events();
5496 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5497 let mut as_failds = HashSet::new();
5498 for event in as_events.iter() {
5499 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5500 assert!(as_failds.insert(*payment_hash));
5501 if *payment_hash != payment_hash_2 {
5502 assert_eq!(*rejected_by_dest, deliver_last_raa);
5504 assert!(!rejected_by_dest);
5506 } else { panic!("Unexpected event"); }
5508 assert!(as_failds.contains(&payment_hash_1));
5509 assert!(as_failds.contains(&payment_hash_2));
5510 if announce_latest {
5511 assert!(as_failds.contains(&payment_hash_3));
5512 assert!(as_failds.contains(&payment_hash_5));
5514 assert!(as_failds.contains(&payment_hash_6));
5516 let bs_events = nodes[1].node.get_and_clear_pending_events();
5517 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5518 let mut bs_failds = HashSet::new();
5519 for event in bs_events.iter() {
5520 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5521 assert!(bs_failds.insert(*payment_hash));
5522 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5523 assert_eq!(*rejected_by_dest, deliver_last_raa);
5525 assert!(!rejected_by_dest);
5527 } else { panic!("Unexpected event"); }
5529 assert!(bs_failds.contains(&payment_hash_1));
5530 assert!(bs_failds.contains(&payment_hash_2));
5531 if announce_latest {
5532 assert!(bs_failds.contains(&payment_hash_4));
5534 assert!(bs_failds.contains(&payment_hash_5));
5536 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5537 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5538 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5539 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5540 // PaymentFailureNetworkUpdates.
5541 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5542 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5543 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5544 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5545 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5547 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5548 _ => panic!("Unexpected event"),
5554 fn test_fail_backwards_latest_remote_announce_a() {
5555 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5559 fn test_fail_backwards_latest_remote_announce_b() {
5560 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5564 fn test_fail_backwards_previous_remote_announce() {
5565 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5566 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5567 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5571 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5572 let chanmon_cfgs = create_chanmon_cfgs(2);
5573 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5574 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5575 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5577 // Create some initial channels
5578 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5580 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5581 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5582 assert_eq!(local_txn[0].input.len(), 1);
5583 check_spends!(local_txn[0], chan_1.3);
5585 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5586 mine_transaction(&nodes[0], &local_txn[0]);
5587 check_closed_broadcast!(nodes[0], true);
5588 check_added_monitors!(nodes[0], 1);
5590 let htlc_timeout = {
5591 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5592 assert_eq!(node_txn[0].input.len(), 1);
5593 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5594 check_spends!(node_txn[0], local_txn[0]);
5598 mine_transaction(&nodes[0], &htlc_timeout);
5599 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5600 expect_payment_failed!(nodes[0], our_payment_hash, true);
5602 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5603 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5604 assert_eq!(spend_txn.len(), 3);
5605 check_spends!(spend_txn[0], local_txn[0]);
5606 check_spends!(spend_txn[1], htlc_timeout);
5607 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5611 fn test_key_derivation_params() {
5612 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5613 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5614 // let us re-derive the channel key set to then derive a delayed_payment_key.
5616 let chanmon_cfgs = create_chanmon_cfgs(3);
5618 // We manually create the node configuration to backup the seed.
5619 let seed = [42; 32];
5620 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5621 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);
5622 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 };
5623 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5624 node_cfgs.remove(0);
5625 node_cfgs.insert(0, node);
5627 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5628 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5630 // Create some initial channels
5631 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5633 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5634 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5635 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5637 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5638 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5639 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5640 assert_eq!(local_txn_1[0].input.len(), 1);
5641 check_spends!(local_txn_1[0], chan_1.3);
5643 // We check funding pubkey are unique
5644 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]));
5645 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]));
5646 if from_0_funding_key_0 == from_1_funding_key_0
5647 || from_0_funding_key_0 == from_1_funding_key_1
5648 || from_0_funding_key_1 == from_1_funding_key_0
5649 || from_0_funding_key_1 == from_1_funding_key_1 {
5650 panic!("Funding pubkeys aren't unique");
5653 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5654 mine_transaction(&nodes[0], &local_txn_1[0]);
5655 check_closed_broadcast!(nodes[0], true);
5656 check_added_monitors!(nodes[0], 1);
5658 let htlc_timeout = {
5659 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5660 assert_eq!(node_txn[0].input.len(), 1);
5661 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5662 check_spends!(node_txn[0], local_txn_1[0]);
5666 mine_transaction(&nodes[0], &htlc_timeout);
5667 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5668 expect_payment_failed!(nodes[0], our_payment_hash, true);
5670 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5671 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5672 let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5673 assert_eq!(spend_txn.len(), 3);
5674 check_spends!(spend_txn[0], local_txn_1[0]);
5675 check_spends!(spend_txn[1], htlc_timeout);
5676 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5680 fn test_static_output_closing_tx() {
5681 let chanmon_cfgs = create_chanmon_cfgs(2);
5682 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5683 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5684 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5686 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5688 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5689 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5691 mine_transaction(&nodes[0], &closing_tx);
5692 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5694 let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5695 assert_eq!(spend_txn.len(), 1);
5696 check_spends!(spend_txn[0], closing_tx);
5698 mine_transaction(&nodes[1], &closing_tx);
5699 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5701 let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5702 assert_eq!(spend_txn.len(), 1);
5703 check_spends!(spend_txn[0], closing_tx);
5706 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5707 let chanmon_cfgs = create_chanmon_cfgs(2);
5708 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5709 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5710 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5711 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5713 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5715 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5716 // present in B's local commitment transaction, but none of A's commitment transactions.
5717 assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5718 check_added_monitors!(nodes[1], 1);
5720 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5721 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5722 let events = nodes[0].node.get_and_clear_pending_events();
5723 assert_eq!(events.len(), 1);
5725 Event::PaymentSent { payment_preimage } => {
5726 assert_eq!(payment_preimage, our_payment_preimage);
5728 _ => panic!("Unexpected event"),
5731 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5732 check_added_monitors!(nodes[0], 1);
5733 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5734 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5735 check_added_monitors!(nodes[1], 1);
5737 let starting_block = nodes[1].best_block_info();
5738 let mut block = Block {
5739 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5742 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5743 connect_block(&nodes[1], &block);
5744 block.header.prev_blockhash = block.block_hash();
5746 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5747 check_closed_broadcast!(nodes[1], true);
5748 check_added_monitors!(nodes[1], 1);
5751 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5752 let chanmon_cfgs = create_chanmon_cfgs(2);
5753 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5754 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5755 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5756 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5757 let logger = test_utils::TestLogger::new();
5759 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5760 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5761 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5762 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5763 check_added_monitors!(nodes[0], 1);
5765 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5767 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5768 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5769 // to "time out" the HTLC.
5771 let starting_block = nodes[1].best_block_info();
5772 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5774 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5775 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5776 header.prev_blockhash = header.block_hash();
5778 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5779 check_closed_broadcast!(nodes[0], true);
5780 check_added_monitors!(nodes[0], 1);
5783 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5784 let chanmon_cfgs = create_chanmon_cfgs(3);
5785 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5786 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5787 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5788 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5790 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5791 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5792 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5793 // actually revoked.
5794 let htlc_value = if use_dust { 50000 } else { 3000000 };
5795 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5796 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5797 expect_pending_htlcs_forwardable!(nodes[1]);
5798 check_added_monitors!(nodes[1], 1);
5800 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5801 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5802 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5803 check_added_monitors!(nodes[0], 1);
5804 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5805 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5806 check_added_monitors!(nodes[1], 1);
5807 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5808 check_added_monitors!(nodes[1], 1);
5809 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5811 if check_revoke_no_close {
5812 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5813 check_added_monitors!(nodes[0], 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 + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5822 connect_block(&nodes[0], &block);
5823 block.header.prev_blockhash = block.block_hash();
5825 if !check_revoke_no_close {
5826 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5827 check_closed_broadcast!(nodes[0], true);
5828 check_added_monitors!(nodes[0], 1);
5830 expect_payment_failed!(nodes[0], our_payment_hash, true);
5834 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5835 // There are only a few cases to test here:
5836 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
5837 // broadcastable commitment transactions result in channel closure,
5838 // * its included in an unrevoked-but-previous remote commitment transaction,
5839 // * its included in the latest remote or local commitment transactions.
5840 // We test each of the three possible commitment transactions individually and use both dust and
5842 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5843 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5844 // tested for at least one of the cases in other tests.
5846 fn htlc_claim_single_commitment_only_a() {
5847 do_htlc_claim_local_commitment_only(true);
5848 do_htlc_claim_local_commitment_only(false);
5850 do_htlc_claim_current_remote_commitment_only(true);
5851 do_htlc_claim_current_remote_commitment_only(false);
5855 fn htlc_claim_single_commitment_only_b() {
5856 do_htlc_claim_previous_remote_commitment_only(true, false);
5857 do_htlc_claim_previous_remote_commitment_only(false, false);
5858 do_htlc_claim_previous_remote_commitment_only(true, true);
5859 do_htlc_claim_previous_remote_commitment_only(false, true);
5864 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5865 let chanmon_cfgs = create_chanmon_cfgs(2);
5866 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5867 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5868 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5869 //Force duplicate channel ids
5870 for node in nodes.iter() {
5871 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5874 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5875 let channel_value_satoshis=10000;
5876 let push_msat=10001;
5877 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5878 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5879 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5881 //Create a second channel with a channel_id collision
5882 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5886 fn bolt2_open_channel_sending_node_checks_part2() {
5887 let chanmon_cfgs = create_chanmon_cfgs(2);
5888 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5889 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5890 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5892 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5893 let channel_value_satoshis=2^24;
5894 let push_msat=10001;
5895 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5897 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5898 let channel_value_satoshis=10000;
5899 // Test when push_msat is equal to 1000 * funding_satoshis.
5900 let push_msat=1000*channel_value_satoshis+1;
5901 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5903 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5904 let channel_value_satoshis=10000;
5905 let push_msat=10001;
5906 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
5907 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5908 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5910 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5911 // 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
5912 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5914 // 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.
5915 assert!(BREAKDOWN_TIMEOUT>0);
5916 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5918 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5919 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5920 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5922 // 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.
5923 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5924 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5925 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5926 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5927 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5931 fn bolt2_open_channel_sane_dust_limit() {
5932 let chanmon_cfgs = create_chanmon_cfgs(2);
5933 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5934 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5935 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5937 let channel_value_satoshis=1000000;
5938 let push_msat=10001;
5939 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5940 let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5941 node0_to_1_send_open_channel.dust_limit_satoshis = 661;
5942 node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
5944 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5945 let events = nodes[1].node.get_and_clear_pending_msg_events();
5946 let err_msg = match events[0] {
5947 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
5950 _ => panic!("Unexpected event"),
5952 assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
5955 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5956 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5957 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5958 // is no longer affordable once it's freed.
5960 fn test_fail_holding_cell_htlc_upon_free() {
5961 let chanmon_cfgs = create_chanmon_cfgs(2);
5962 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5963 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5964 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5965 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5966 let logger = test_utils::TestLogger::new();
5968 // First nodes[0] generates an update_fee, setting the channel's
5969 // pending_update_fee.
5970 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
5971 check_added_monitors!(nodes[0], 1);
5973 let events = nodes[0].node.get_and_clear_pending_msg_events();
5974 assert_eq!(events.len(), 1);
5975 let (update_msg, commitment_signed) = match events[0] {
5976 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5977 (update_fee.as_ref(), commitment_signed)
5979 _ => panic!("Unexpected event"),
5982 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5984 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5985 let channel_reserve = chan_stat.channel_reserve_msat;
5986 let feerate = get_feerate!(nodes[0], chan.2);
5988 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5989 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5990 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
5991 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5992 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
5994 // Send a payment which passes reserve checks but gets stuck in the holding cell.
5995 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5996 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5997 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5999 // Flush the pending fee update.
6000 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6001 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6002 check_added_monitors!(nodes[1], 1);
6003 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6004 check_added_monitors!(nodes[0], 1);
6006 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6007 // HTLC, but now that the fee has been raised the payment will now fail, causing
6008 // us to surface its failure to the user.
6009 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6010 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6011 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6012 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 ({})", log_bytes!(our_payment_hash.0), chan_stat.channel_reserve_msat);
6013 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6015 // Check that the payment failed to be sent out.
6016 let events = nodes[0].node.get_and_clear_pending_events();
6017 assert_eq!(events.len(), 1);
6019 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6020 assert_eq!(our_payment_hash.clone(), *payment_hash);
6021 assert_eq!(*rejected_by_dest, false);
6022 assert_eq!(*error_code, None);
6023 assert_eq!(*error_data, None);
6025 _ => panic!("Unexpected event"),
6029 // Test that if multiple HTLCs are released from the holding cell and one is
6030 // valid but the other is no longer valid upon release, the valid HTLC can be
6031 // successfully completed while the other one fails as expected.
6033 fn test_free_and_fail_holding_cell_htlcs() {
6034 let chanmon_cfgs = create_chanmon_cfgs(2);
6035 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6036 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6037 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6038 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6039 let logger = test_utils::TestLogger::new();
6041 // First nodes[0] generates an update_fee, setting the channel's
6042 // pending_update_fee.
6043 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6044 check_added_monitors!(nodes[0], 1);
6046 let events = nodes[0].node.get_and_clear_pending_msg_events();
6047 assert_eq!(events.len(), 1);
6048 let (update_msg, commitment_signed) = match events[0] {
6049 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6050 (update_fee.as_ref(), commitment_signed)
6052 _ => panic!("Unexpected event"),
6055 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6057 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6058 let channel_reserve = chan_stat.channel_reserve_msat;
6059 let feerate = get_feerate!(nodes[0], chan.2);
6061 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6062 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6064 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6065 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6066 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6067 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6068 let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6070 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6071 nodes[0].node.send_payment(&route_1, payment_hash_1, &None).unwrap();
6072 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6073 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6074 nodes[0].node.send_payment(&route_2, payment_hash_2, &None).unwrap();
6075 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6076 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6078 // Flush the pending fee update.
6079 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6080 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6081 check_added_monitors!(nodes[1], 1);
6082 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6083 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6084 check_added_monitors!(nodes[0], 2);
6086 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6087 // but now that the fee has been raised the second payment will now fail, causing us
6088 // to surface its failure to the user. The first payment should succeed.
6089 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6090 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6091 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6092 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 ({})", log_bytes!(payment_hash_2.0), chan_stat.channel_reserve_msat);
6093 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6095 // Check that the second payment failed to be sent out.
6096 let events = nodes[0].node.get_and_clear_pending_events();
6097 assert_eq!(events.len(), 1);
6099 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6100 assert_eq!(payment_hash_2.clone(), *payment_hash);
6101 assert_eq!(*rejected_by_dest, false);
6102 assert_eq!(*error_code, None);
6103 assert_eq!(*error_data, None);
6105 _ => panic!("Unexpected event"),
6108 // Complete the first payment and the RAA from the fee update.
6109 let (payment_event, send_raa_event) = {
6110 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6111 assert_eq!(msgs.len(), 2);
6112 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6114 let raa = match send_raa_event {
6115 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6116 _ => panic!("Unexpected event"),
6118 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6119 check_added_monitors!(nodes[1], 1);
6120 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6121 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6122 let events = nodes[1].node.get_and_clear_pending_events();
6123 assert_eq!(events.len(), 1);
6125 Event::PendingHTLCsForwardable { .. } => {},
6126 _ => panic!("Unexpected event"),
6128 nodes[1].node.process_pending_htlc_forwards();
6129 let events = nodes[1].node.get_and_clear_pending_events();
6130 assert_eq!(events.len(), 1);
6132 Event::PaymentReceived { .. } => {},
6133 _ => panic!("Unexpected event"),
6135 nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
6136 check_added_monitors!(nodes[1], 1);
6137 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6138 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6139 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6140 let events = nodes[0].node.get_and_clear_pending_events();
6141 assert_eq!(events.len(), 1);
6143 Event::PaymentSent { ref payment_preimage } => {
6144 assert_eq!(*payment_preimage, payment_preimage_1);
6146 _ => panic!("Unexpected event"),
6150 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6151 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6152 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6155 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6156 let chanmon_cfgs = create_chanmon_cfgs(3);
6157 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6158 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6159 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6160 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6161 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6162 let logger = test_utils::TestLogger::new();
6164 // First nodes[1] generates an update_fee, setting the channel's
6165 // pending_update_fee.
6166 nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6167 check_added_monitors!(nodes[1], 1);
6169 let events = nodes[1].node.get_and_clear_pending_msg_events();
6170 assert_eq!(events.len(), 1);
6171 let (update_msg, commitment_signed) = match events[0] {
6172 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6173 (update_fee.as_ref(), commitment_signed)
6175 _ => panic!("Unexpected event"),
6178 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6180 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6181 let channel_reserve = chan_stat.channel_reserve_msat;
6182 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6184 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6186 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6187 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6188 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6189 let payment_event = {
6190 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6191 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6192 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6193 check_added_monitors!(nodes[0], 1);
6195 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6196 assert_eq!(events.len(), 1);
6198 SendEvent::from_event(events.remove(0))
6200 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6201 check_added_monitors!(nodes[1], 0);
6202 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6203 expect_pending_htlcs_forwardable!(nodes[1]);
6205 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6206 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6208 // Flush the pending fee update.
6209 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6210 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6211 check_added_monitors!(nodes[2], 1);
6212 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6213 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6214 check_added_monitors!(nodes[1], 2);
6216 // A final RAA message is generated to finalize the fee update.
6217 let events = nodes[1].node.get_and_clear_pending_msg_events();
6218 assert_eq!(events.len(), 1);
6220 let raa_msg = match &events[0] {
6221 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6224 _ => panic!("Unexpected event"),
6227 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6228 check_added_monitors!(nodes[2], 1);
6229 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6231 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6232 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6233 assert_eq!(process_htlc_forwards_event.len(), 1);
6234 match &process_htlc_forwards_event[0] {
6235 &Event::PendingHTLCsForwardable { .. } => {},
6236 _ => panic!("Unexpected event"),
6239 // In response, we call ChannelManager's process_pending_htlc_forwards
6240 nodes[1].node.process_pending_htlc_forwards();
6241 check_added_monitors!(nodes[1], 1);
6243 // This causes the HTLC to be failed backwards.
6244 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6245 assert_eq!(fail_event.len(), 1);
6246 let (fail_msg, commitment_signed) = match &fail_event[0] {
6247 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6248 assert_eq!(updates.update_add_htlcs.len(), 0);
6249 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6250 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6251 assert_eq!(updates.update_fail_htlcs.len(), 1);
6252 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6254 _ => panic!("Unexpected event"),
6257 // Pass the failure messages back to nodes[0].
6258 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6259 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6261 // Complete the HTLC failure+removal process.
6262 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6263 check_added_monitors!(nodes[0], 1);
6264 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6265 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6266 check_added_monitors!(nodes[1], 2);
6267 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6268 assert_eq!(final_raa_event.len(), 1);
6269 let raa = match &final_raa_event[0] {
6270 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6271 _ => panic!("Unexpected event"),
6273 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6274 let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6275 assert_eq!(fail_msg_event.len(), 1);
6276 match &fail_msg_event[0] {
6277 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6278 _ => panic!("Unexpected event"),
6280 let failure_event = nodes[0].node.get_and_clear_pending_events();
6281 assert_eq!(failure_event.len(), 1);
6282 match &failure_event[0] {
6283 &Event::PaymentFailed { rejected_by_dest, .. } => {
6284 assert!(!rejected_by_dest);
6286 _ => panic!("Unexpected event"),
6288 check_added_monitors!(nodes[0], 1);
6291 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6292 // 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.
6293 //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.
6296 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6297 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6298 let chanmon_cfgs = create_chanmon_cfgs(2);
6299 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6300 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6301 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6302 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6304 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6305 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6306 let logger = test_utils::TestLogger::new();
6307 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6308 route.paths[0][0].fee_msat = 100;
6310 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6311 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6312 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6313 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6317 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6318 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6319 let chanmon_cfgs = create_chanmon_cfgs(2);
6320 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6321 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6322 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6323 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6324 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6326 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6327 let logger = test_utils::TestLogger::new();
6328 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6329 route.paths[0][0].fee_msat = 0;
6330 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6331 assert_eq!(err, "Cannot send 0-msat HTLC"));
6333 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6334 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6338 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6339 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6340 let chanmon_cfgs = create_chanmon_cfgs(2);
6341 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6342 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6343 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6344 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6346 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6347 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6348 let logger = test_utils::TestLogger::new();
6349 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6350 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6351 check_added_monitors!(nodes[0], 1);
6352 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6353 updates.update_add_htlcs[0].amount_msat = 0;
6355 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6356 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6357 check_closed_broadcast!(nodes[1], true).unwrap();
6358 check_added_monitors!(nodes[1], 1);
6362 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6363 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6364 //It is enforced when constructing a route.
6365 let chanmon_cfgs = create_chanmon_cfgs(2);
6366 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6367 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6368 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6369 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6370 let logger = test_utils::TestLogger::new();
6372 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6374 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6375 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000000, 500000001, &logger).unwrap();
6376 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6377 assert_eq!(err, &"Channel CLTV overflowed?"));
6381 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6382 //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.
6383 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6384 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6385 let chanmon_cfgs = create_chanmon_cfgs(2);
6386 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6387 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6388 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6389 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6390 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6392 let logger = test_utils::TestLogger::new();
6393 for i in 0..max_accepted_htlcs {
6394 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6395 let payment_event = {
6396 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6397 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6398 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6399 check_added_monitors!(nodes[0], 1);
6401 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6402 assert_eq!(events.len(), 1);
6403 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6404 assert_eq!(htlcs[0].htlc_id, i);
6408 SendEvent::from_event(events.remove(0))
6410 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6411 check_added_monitors!(nodes[1], 0);
6412 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6414 expect_pending_htlcs_forwardable!(nodes[1]);
6415 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6417 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6418 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6419 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6420 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6421 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6423 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6424 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6428 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6429 //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.
6430 let chanmon_cfgs = create_chanmon_cfgs(2);
6431 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6432 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6433 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6434 let channel_value = 100000;
6435 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6436 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6438 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6440 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6441 // Manually create a route over our max in flight (which our router normally automatically
6443 let route = Route { paths: vec![vec![RouteHop {
6444 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6445 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6446 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6448 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6449 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)));
6451 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6452 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);
6454 send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6457 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6459 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6460 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6461 let chanmon_cfgs = create_chanmon_cfgs(2);
6462 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6463 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6464 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6465 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6466 let htlc_minimum_msat: u64;
6468 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6469 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6470 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6473 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6474 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6475 let logger = test_utils::TestLogger::new();
6476 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6477 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6478 check_added_monitors!(nodes[0], 1);
6479 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6480 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6481 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6482 assert!(nodes[1].node.list_channels().is_empty());
6483 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6484 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()));
6485 check_added_monitors!(nodes[1], 1);
6489 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6490 //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
6491 let chanmon_cfgs = create_chanmon_cfgs(2);
6492 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6493 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6494 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6495 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6496 let logger = test_utils::TestLogger::new();
6498 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6499 let channel_reserve = chan_stat.channel_reserve_msat;
6500 let feerate = get_feerate!(nodes[0], chan.2);
6501 // The 2* and +1 are for the fee spike reserve.
6502 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6504 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6505 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6506 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6507 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6508 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6509 check_added_monitors!(nodes[0], 1);
6510 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6512 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6513 // at this time channel-initiatee receivers are not required to enforce that senders
6514 // respect the fee_spike_reserve.
6515 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6516 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6518 assert!(nodes[1].node.list_channels().is_empty());
6519 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6520 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6521 check_added_monitors!(nodes[1], 1);
6525 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6526 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6527 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6528 let chanmon_cfgs = create_chanmon_cfgs(2);
6529 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6530 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6531 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6532 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6533 let logger = test_utils::TestLogger::new();
6535 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6536 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6538 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6539 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6541 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6542 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6543 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6544 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6546 let mut msg = msgs::UpdateAddHTLC {
6550 payment_hash: our_payment_hash,
6551 cltv_expiry: htlc_cltv,
6552 onion_routing_packet: onion_packet.clone(),
6555 for i in 0..super::channel::OUR_MAX_HTLCS {
6556 msg.htlc_id = i as u64;
6557 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6559 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6560 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6562 assert!(nodes[1].node.list_channels().is_empty());
6563 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6564 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6565 check_added_monitors!(nodes[1], 1);
6569 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6570 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6571 let chanmon_cfgs = create_chanmon_cfgs(2);
6572 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6573 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6574 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6575 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6576 let logger = test_utils::TestLogger::new();
6578 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6579 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6580 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6581 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6582 check_added_monitors!(nodes[0], 1);
6583 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6584 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6585 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6587 assert!(nodes[1].node.list_channels().is_empty());
6588 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6589 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6590 check_added_monitors!(nodes[1], 1);
6594 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6595 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6596 let chanmon_cfgs = create_chanmon_cfgs(2);
6597 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6598 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6599 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6600 let logger = test_utils::TestLogger::new();
6602 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6603 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6604 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6605 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6606 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6607 check_added_monitors!(nodes[0], 1);
6608 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6609 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6610 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6612 assert!(nodes[1].node.list_channels().is_empty());
6613 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6614 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6615 check_added_monitors!(nodes[1], 1);
6619 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6620 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6621 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6622 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6623 let chanmon_cfgs = create_chanmon_cfgs(2);
6624 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6625 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6626 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6627 let logger = test_utils::TestLogger::new();
6629 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6630 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6631 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6632 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6633 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6634 check_added_monitors!(nodes[0], 1);
6635 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6636 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6638 //Disconnect and Reconnect
6639 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6640 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6641 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6642 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6643 assert_eq!(reestablish_1.len(), 1);
6644 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6645 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6646 assert_eq!(reestablish_2.len(), 1);
6647 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6648 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6649 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6650 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6653 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6654 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6655 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6656 check_added_monitors!(nodes[1], 1);
6657 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6659 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6661 assert!(nodes[1].node.list_channels().is_empty());
6662 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6663 assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6664 check_added_monitors!(nodes[1], 1);
6668 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6669 //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.
6671 let chanmon_cfgs = create_chanmon_cfgs(2);
6672 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6673 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6674 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6675 let logger = test_utils::TestLogger::new();
6676 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6677 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
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.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6680 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6682 check_added_monitors!(nodes[0], 1);
6683 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6684 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6686 let update_msg = msgs::UpdateFulfillHTLC{
6689 payment_preimage: our_payment_preimage,
6692 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6694 assert!(nodes[0].node.list_channels().is_empty());
6695 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6696 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()));
6697 check_added_monitors!(nodes[0], 1);
6701 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6702 //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.
6704 let chanmon_cfgs = create_chanmon_cfgs(2);
6705 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6706 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6707 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6708 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6709 let logger = test_utils::TestLogger::new();
6711 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6712 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6713 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6714 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6715 check_added_monitors!(nodes[0], 1);
6716 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6717 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6719 let update_msg = msgs::UpdateFailHTLC{
6722 reason: msgs::OnionErrorPacket { data: Vec::new()},
6725 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6727 assert!(nodes[0].node.list_channels().is_empty());
6728 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6729 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()));
6730 check_added_monitors!(nodes[0], 1);
6734 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6735 //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.
6737 let chanmon_cfgs = create_chanmon_cfgs(2);
6738 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6739 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6740 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6741 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6742 let logger = test_utils::TestLogger::new();
6744 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6745 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6746 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6747 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6748 check_added_monitors!(nodes[0], 1);
6749 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6750 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6751 let update_msg = msgs::UpdateFailMalformedHTLC{
6754 sha256_of_onion: [1; 32],
6755 failure_code: 0x8000,
6758 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6760 assert!(nodes[0].node.list_channels().is_empty());
6761 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6762 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()));
6763 check_added_monitors!(nodes[0], 1);
6767 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6768 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6770 let chanmon_cfgs = create_chanmon_cfgs(2);
6771 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6772 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6773 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6774 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6776 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6778 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6779 check_added_monitors!(nodes[1], 1);
6781 let events = nodes[1].node.get_and_clear_pending_msg_events();
6782 assert_eq!(events.len(), 1);
6783 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6785 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, .. } } => {
6786 assert!(update_add_htlcs.is_empty());
6787 assert_eq!(update_fulfill_htlcs.len(), 1);
6788 assert!(update_fail_htlcs.is_empty());
6789 assert!(update_fail_malformed_htlcs.is_empty());
6790 assert!(update_fee.is_none());
6791 update_fulfill_htlcs[0].clone()
6793 _ => panic!("Unexpected event"),
6797 update_fulfill_msg.htlc_id = 1;
6799 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6801 assert!(nodes[0].node.list_channels().is_empty());
6802 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6803 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6804 check_added_monitors!(nodes[0], 1);
6808 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6809 //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.
6811 let chanmon_cfgs = create_chanmon_cfgs(2);
6812 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6813 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6814 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6815 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6817 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6819 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6820 check_added_monitors!(nodes[1], 1);
6822 let events = nodes[1].node.get_and_clear_pending_msg_events();
6823 assert_eq!(events.len(), 1);
6824 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6826 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, .. } } => {
6827 assert!(update_add_htlcs.is_empty());
6828 assert_eq!(update_fulfill_htlcs.len(), 1);
6829 assert!(update_fail_htlcs.is_empty());
6830 assert!(update_fail_malformed_htlcs.is_empty());
6831 assert!(update_fee.is_none());
6832 update_fulfill_htlcs[0].clone()
6834 _ => panic!("Unexpected event"),
6838 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6840 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6842 assert!(nodes[0].node.list_channels().is_empty());
6843 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6844 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6845 check_added_monitors!(nodes[0], 1);
6849 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6850 //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.
6852 let chanmon_cfgs = create_chanmon_cfgs(2);
6853 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6854 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6855 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6856 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6857 let logger = test_utils::TestLogger::new();
6859 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6860 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6861 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6862 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6863 check_added_monitors!(nodes[0], 1);
6865 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6866 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6868 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6869 check_added_monitors!(nodes[1], 0);
6870 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6872 let events = nodes[1].node.get_and_clear_pending_msg_events();
6874 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6876 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, .. } } => {
6877 assert!(update_add_htlcs.is_empty());
6878 assert!(update_fulfill_htlcs.is_empty());
6879 assert!(update_fail_htlcs.is_empty());
6880 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6881 assert!(update_fee.is_none());
6882 update_fail_malformed_htlcs[0].clone()
6884 _ => panic!("Unexpected event"),
6887 update_msg.failure_code &= !0x8000;
6888 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6890 assert!(nodes[0].node.list_channels().is_empty());
6891 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6892 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6893 check_added_monitors!(nodes[0], 1);
6897 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6898 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6899 // * 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.
6901 let chanmon_cfgs = create_chanmon_cfgs(3);
6902 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6903 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6904 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6905 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6906 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6907 let logger = test_utils::TestLogger::new();
6909 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6912 let mut payment_event = {
6913 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6914 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
6915 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6916 check_added_monitors!(nodes[0], 1);
6917 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6918 assert_eq!(events.len(), 1);
6919 SendEvent::from_event(events.remove(0))
6921 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6922 check_added_monitors!(nodes[1], 0);
6923 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6924 expect_pending_htlcs_forwardable!(nodes[1]);
6925 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6926 assert_eq!(events_2.len(), 1);
6927 check_added_monitors!(nodes[1], 1);
6928 payment_event = SendEvent::from_event(events_2.remove(0));
6929 assert_eq!(payment_event.msgs.len(), 1);
6932 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6933 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6934 check_added_monitors!(nodes[2], 0);
6935 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6937 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6938 assert_eq!(events_3.len(), 1);
6939 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6941 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 } } => {
6942 assert!(update_add_htlcs.is_empty());
6943 assert!(update_fulfill_htlcs.is_empty());
6944 assert!(update_fail_htlcs.is_empty());
6945 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6946 assert!(update_fee.is_none());
6947 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6949 _ => panic!("Unexpected event"),
6953 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6955 check_added_monitors!(nodes[1], 0);
6956 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6957 expect_pending_htlcs_forwardable!(nodes[1]);
6958 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6959 assert_eq!(events_4.len(), 1);
6961 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6963 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, .. } } => {
6964 assert!(update_add_htlcs.is_empty());
6965 assert!(update_fulfill_htlcs.is_empty());
6966 assert_eq!(update_fail_htlcs.len(), 1);
6967 assert!(update_fail_malformed_htlcs.is_empty());
6968 assert!(update_fee.is_none());
6970 _ => panic!("Unexpected event"),
6973 check_added_monitors!(nodes[1], 1);
6976 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6977 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6978 // 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
6979 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6981 let mut chanmon_cfgs = create_chanmon_cfgs(2);
6982 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6983 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6984 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6985 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6986 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6988 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6990 // We route 2 dust-HTLCs between A and B
6991 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6992 let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6993 route_payment(&nodes[0], &[&nodes[1]], 1000000);
6995 // Cache one local commitment tx as previous
6996 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6998 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6999 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
7000 check_added_monitors!(nodes[1], 0);
7001 expect_pending_htlcs_forwardable!(nodes[1]);
7002 check_added_monitors!(nodes[1], 1);
7004 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7005 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7006 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7007 check_added_monitors!(nodes[0], 1);
7009 // Cache one local commitment tx as lastest
7010 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7012 let events = nodes[0].node.get_and_clear_pending_msg_events();
7014 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7015 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7017 _ => panic!("Unexpected event"),
7020 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7021 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7023 _ => panic!("Unexpected event"),
7026 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7027 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7028 if announce_latest {
7029 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7031 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7034 check_closed_broadcast!(nodes[0], true);
7035 check_added_monitors!(nodes[0], 1);
7037 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7038 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7039 let events = nodes[0].node.get_and_clear_pending_events();
7040 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7041 assert_eq!(events.len(), 2);
7042 let mut first_failed = false;
7043 for event in events {
7045 Event::PaymentFailed { payment_hash, .. } => {
7046 if payment_hash == payment_hash_1 {
7047 assert!(!first_failed);
7048 first_failed = true;
7050 assert_eq!(payment_hash, payment_hash_2);
7053 _ => panic!("Unexpected event"),
7059 fn test_failure_delay_dust_htlc_local_commitment() {
7060 do_test_failure_delay_dust_htlc_local_commitment(true);
7061 do_test_failure_delay_dust_htlc_local_commitment(false);
7064 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7065 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7066 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7067 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7068 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7069 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7070 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7072 let chanmon_cfgs = create_chanmon_cfgs(3);
7073 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7074 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7075 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7076 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7078 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7080 let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7081 let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7083 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7084 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7086 // We revoked bs_commitment_tx
7088 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7089 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7092 let mut timeout_tx = Vec::new();
7094 // We fail dust-HTLC 1 by broadcast of local commitment tx
7095 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7096 check_closed_broadcast!(nodes[0], true);
7097 check_added_monitors!(nodes[0], 1);
7098 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7099 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7100 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7101 expect_payment_failed!(nodes[0], dust_hash, true);
7102 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7103 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7104 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7105 mine_transaction(&nodes[0], &timeout_tx[0]);
7106 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7107 expect_payment_failed!(nodes[0], non_dust_hash, true);
7109 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7110 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7111 check_closed_broadcast!(nodes[0], true);
7112 check_added_monitors!(nodes[0], 1);
7113 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7114 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7115 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7117 expect_payment_failed!(nodes[0], dust_hash, true);
7118 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7119 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7120 mine_transaction(&nodes[0], &timeout_tx[0]);
7121 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7122 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7123 expect_payment_failed!(nodes[0], non_dust_hash, true);
7125 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7127 let events = nodes[0].node.get_and_clear_pending_events();
7128 assert_eq!(events.len(), 2);
7131 Event::PaymentFailed { payment_hash, .. } => {
7132 if payment_hash == dust_hash { first = true; }
7133 else { first = false; }
7135 _ => panic!("Unexpected event"),
7138 Event::PaymentFailed { payment_hash, .. } => {
7139 if first { assert_eq!(payment_hash, non_dust_hash); }
7140 else { assert_eq!(payment_hash, dust_hash); }
7142 _ => panic!("Unexpected event"),
7149 fn test_sweep_outbound_htlc_failure_update() {
7150 do_test_sweep_outbound_htlc_failure_update(false, true);
7151 do_test_sweep_outbound_htlc_failure_update(false, false);
7152 do_test_sweep_outbound_htlc_failure_update(true, false);
7156 fn test_upfront_shutdown_script() {
7157 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7158 // enforce it at shutdown message
7160 let mut config = UserConfig::default();
7161 config.channel_options.announced_channel = true;
7162 config.peer_channel_config_limits.force_announced_channel_preference = false;
7163 config.channel_options.commit_upfront_shutdown_pubkey = false;
7164 let user_cfgs = [None, Some(config), None];
7165 let chanmon_cfgs = create_chanmon_cfgs(3);
7166 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7167 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7168 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7170 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7171 let flags = InitFeatures::known();
7172 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7173 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7174 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7175 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7176 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7177 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7178 assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.").unwrap().is_match(check_closed_broadcast!(nodes[2], true).unwrap().data.as_str()));
7179 check_added_monitors!(nodes[2], 1);
7181 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7182 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7183 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7184 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7185 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7186 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7187 let events = nodes[2].node.get_and_clear_pending_msg_events();
7188 assert_eq!(events.len(), 1);
7190 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7191 _ => panic!("Unexpected event"),
7194 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7195 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7196 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7197 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7198 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7199 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7200 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7201 let events = nodes[1].node.get_and_clear_pending_msg_events();
7202 assert_eq!(events.len(), 1);
7204 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7205 _ => panic!("Unexpected event"),
7208 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7209 // channel smoothly, opt-out is from channel initiator here
7210 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7211 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7212 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7213 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7214 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7215 let events = nodes[0].node.get_and_clear_pending_msg_events();
7216 assert_eq!(events.len(), 1);
7218 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7219 _ => panic!("Unexpected event"),
7222 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7223 //// channel smoothly
7224 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7225 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7226 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7227 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7228 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7229 let events = nodes[0].node.get_and_clear_pending_msg_events();
7230 assert_eq!(events.len(), 2);
7232 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7233 _ => panic!("Unexpected event"),
7236 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7237 _ => panic!("Unexpected event"),
7242 fn test_upfront_shutdown_script_unsupport_segwit() {
7243 // We test that channel is closed early
7244 // if a segwit program is passed as upfront shutdown script,
7245 // but the peer does not support segwit.
7246 let chanmon_cfgs = create_chanmon_cfgs(2);
7247 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7248 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7249 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7251 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7253 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7254 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7255 .push_slice(&[0, 0])
7258 let features = InitFeatures::known().clear_shutdown_anysegwit();
7259 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7261 let events = nodes[0].node.get_and_clear_pending_msg_events();
7262 assert_eq!(events.len(), 1);
7264 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7265 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7266 assert!(regex::Regex::new(r"Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: (\([A-Fa-f0-9]+\))").unwrap().is_match(&*msg.data));
7268 _ => panic!("Unexpected event"),
7273 fn test_shutdown_script_any_segwit_allowed() {
7274 let mut config = UserConfig::default();
7275 config.channel_options.announced_channel = true;
7276 config.peer_channel_config_limits.force_announced_channel_preference = false;
7277 config.channel_options.commit_upfront_shutdown_pubkey = false;
7278 let user_cfgs = [None, Some(config), None];
7279 let chanmon_cfgs = create_chanmon_cfgs(3);
7280 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7281 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7282 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7284 //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7285 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7286 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7287 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7288 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7289 .push_slice(&[0, 0])
7291 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7292 let events = nodes[0].node.get_and_clear_pending_msg_events();
7293 assert_eq!(events.len(), 2);
7295 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7296 _ => panic!("Unexpected event"),
7299 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7300 _ => panic!("Unexpected event"),
7305 fn test_shutdown_script_any_segwit_not_allowed() {
7306 let mut config = UserConfig::default();
7307 config.channel_options.announced_channel = true;
7308 config.peer_channel_config_limits.force_announced_channel_preference = false;
7309 config.channel_options.commit_upfront_shutdown_pubkey = false;
7310 let user_cfgs = [None, Some(config), None];
7311 let chanmon_cfgs = create_chanmon_cfgs(3);
7312 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7313 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7314 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7316 //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7317 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7318 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7319 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7320 // Make an any segwit version script
7321 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7322 .push_slice(&[0, 0])
7324 let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7325 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7326 let events = nodes[0].node.get_and_clear_pending_msg_events();
7327 assert_eq!(events.len(), 2);
7329 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7330 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7331 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7333 _ => panic!("Unexpected event"),
7335 check_added_monitors!(nodes[0], 1);
7339 fn test_shutdown_script_segwit_but_not_anysegwit() {
7340 let mut config = UserConfig::default();
7341 config.channel_options.announced_channel = true;
7342 config.peer_channel_config_limits.force_announced_channel_preference = false;
7343 config.channel_options.commit_upfront_shutdown_pubkey = false;
7344 let user_cfgs = [None, Some(config), None];
7345 let chanmon_cfgs = create_chanmon_cfgs(3);
7346 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7347 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7348 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7350 //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7351 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7352 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7353 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7354 // Make a segwit script that is not a valid as any segwit
7355 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7356 .push_slice(&[0, 0])
7358 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7359 let events = nodes[0].node.get_and_clear_pending_msg_events();
7360 assert_eq!(events.len(), 2);
7362 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7363 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7364 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7366 _ => panic!("Unexpected event"),
7368 check_added_monitors!(nodes[0], 1);
7372 fn test_user_configurable_csv_delay() {
7373 // We test our channel constructors yield errors when we pass them absurd csv delay
7375 let mut low_our_to_self_config = UserConfig::default();
7376 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7377 let mut high_their_to_self_config = UserConfig::default();
7378 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7379 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7380 let chanmon_cfgs = create_chanmon_cfgs(2);
7381 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7382 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7383 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7385 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7386 if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7388 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())); },
7389 _ => panic!("Unexpected event"),
7391 } else { assert!(false) }
7393 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7394 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7395 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7396 open_channel.to_self_delay = 200;
7397 if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7399 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())); },
7400 _ => panic!("Unexpected event"),
7402 } else { assert!(false); }
7404 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7405 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7406 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()));
7407 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7408 accept_channel.to_self_delay = 200;
7409 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7410 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7412 &ErrorAction::SendErrorMessage { ref msg } => {
7413 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()));
7415 _ => { assert!(false); }
7417 } else { assert!(false); }
7419 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7420 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7421 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7422 open_channel.to_self_delay = 200;
7423 if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7425 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())); },
7426 _ => panic!("Unexpected event"),
7428 } else { assert!(false); }
7432 fn test_data_loss_protect() {
7433 // We want to be sure that :
7434 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7435 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7436 // * we close channel in case of detecting other being fallen behind
7437 // * we are able to claim our own outputs thanks to to_remote being static
7438 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7444 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7445 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7446 // during signing due to revoked tx
7447 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7448 let keys_manager = &chanmon_cfgs[0].keys_manager;
7451 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7452 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7453 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7455 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7457 // Cache node A state before any channel update
7458 let previous_node_state = nodes[0].node.encode();
7459 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7460 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7462 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7463 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7465 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7466 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7468 // Restore node A from previous state
7469 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7470 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7471 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7472 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7473 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7474 persister = test_utils::TestPersister::new();
7475 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7477 let mut channel_monitors = HashMap::new();
7478 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7479 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7480 keys_manager: keys_manager,
7481 fee_estimator: &fee_estimator,
7482 chain_monitor: &monitor,
7484 tx_broadcaster: &tx_broadcaster,
7485 default_config: UserConfig::default(),
7489 nodes[0].node = &node_state_0;
7490 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7491 nodes[0].chain_monitor = &monitor;
7492 nodes[0].chain_source = &chain_source;
7494 check_added_monitors!(nodes[0], 1);
7496 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7497 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7499 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7501 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7502 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7503 check_added_monitors!(nodes[0], 1);
7506 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7507 assert_eq!(node_txn.len(), 0);
7510 let mut reestablish_1 = Vec::with_capacity(1);
7511 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7512 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7513 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7514 reestablish_1.push(msg.clone());
7515 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7516 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7518 &ErrorAction::SendErrorMessage { ref msg } => {
7519 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");
7521 _ => panic!("Unexpected event!"),
7524 panic!("Unexpected event")
7528 // Check we close channel detecting A is fallen-behind
7529 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7530 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7531 check_added_monitors!(nodes[1], 1);
7534 // Check A is able to claim to_remote output
7535 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7536 assert_eq!(node_txn.len(), 1);
7537 check_spends!(node_txn[0], chan.3);
7538 assert_eq!(node_txn[0].output.len(), 2);
7539 mine_transaction(&nodes[0], &node_txn[0]);
7540 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7541 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7542 assert_eq!(spend_txn.len(), 1);
7543 check_spends!(spend_txn[0], node_txn[0]);
7547 fn test_check_htlc_underpaying() {
7548 // Send payment through A -> B but A is maliciously
7549 // sending a probe payment (i.e less than expected value0
7550 // to B, B should refuse payment.
7552 let chanmon_cfgs = create_chanmon_cfgs(2);
7553 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7554 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7555 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7557 // Create some initial channels
7558 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7560 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7562 // Node 3 is expecting payment of 100_000 but receive 10_000,
7563 // fail htlc like we didn't know the preimage.
7564 nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7565 nodes[1].node.process_pending_htlc_forwards();
7567 let events = nodes[1].node.get_and_clear_pending_msg_events();
7568 assert_eq!(events.len(), 1);
7569 let (update_fail_htlc, commitment_signed) = match events[0] {
7570 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 } } => {
7571 assert!(update_add_htlcs.is_empty());
7572 assert!(update_fulfill_htlcs.is_empty());
7573 assert_eq!(update_fail_htlcs.len(), 1);
7574 assert!(update_fail_malformed_htlcs.is_empty());
7575 assert!(update_fee.is_none());
7576 (update_fail_htlcs[0].clone(), commitment_signed)
7578 _ => panic!("Unexpected event"),
7580 check_added_monitors!(nodes[1], 1);
7582 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7583 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7585 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7586 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7587 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7588 expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7589 nodes[1].node.get_and_clear_pending_events();
7593 fn test_announce_disable_channels() {
7594 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7595 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7597 let chanmon_cfgs = create_chanmon_cfgs(2);
7598 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7599 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7600 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7602 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7603 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7604 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7607 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7608 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7610 nodes[0].node.timer_tick_occurred(); // dirty -> stagged
7611 nodes[0].node.timer_tick_occurred(); // staged -> fresh
7612 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7613 assert_eq!(msg_events.len(), 3);
7614 for e in msg_events {
7616 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7617 let short_id = msg.contents.short_channel_id;
7618 // Check generated channel_update match list in PendingChannelUpdate
7619 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7620 panic!("Generated ChannelUpdate for wrong chan!");
7623 _ => panic!("Unexpected event"),
7627 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7628 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7629 assert_eq!(reestablish_1.len(), 3);
7630 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7631 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7632 assert_eq!(reestablish_2.len(), 3);
7634 // Reestablish chan_1
7635 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7636 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7637 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7638 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7639 // Reestablish chan_2
7640 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7641 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7642 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7643 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7644 // Reestablish chan_3
7645 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7646 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7647 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7648 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7650 nodes[0].node.timer_tick_occurred();
7651 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7655 fn test_bump_penalty_txn_on_revoked_commitment() {
7656 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7657 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7659 let chanmon_cfgs = create_chanmon_cfgs(2);
7660 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7661 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7662 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7664 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7665 let logger = test_utils::TestLogger::new();
7667 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7668 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7669 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 3000000, 30, &logger).unwrap();
7670 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7672 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7673 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7674 assert_eq!(revoked_txn[0].output.len(), 4);
7675 assert_eq!(revoked_txn[0].input.len(), 1);
7676 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7677 let revoked_txid = revoked_txn[0].txid();
7679 let mut penalty_sum = 0;
7680 for outp in revoked_txn[0].output.iter() {
7681 if outp.script_pubkey.is_v0_p2wsh() {
7682 penalty_sum += outp.value;
7686 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7687 let header_114 = connect_blocks(&nodes[1], 14);
7689 // Actually revoke tx by claiming a HTLC
7690 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7691 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7692 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7693 check_added_monitors!(nodes[1], 1);
7695 // One or more justice tx should have been broadcast, check it
7699 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7700 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7701 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7702 assert_eq!(node_txn[0].output.len(), 1);
7703 check_spends!(node_txn[0], revoked_txn[0]);
7704 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7705 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7706 penalty_1 = node_txn[0].txid();
7710 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7711 connect_blocks(&nodes[1], 15);
7712 let mut penalty_2 = penalty_1;
7713 let mut feerate_2 = 0;
7715 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7716 assert_eq!(node_txn.len(), 1);
7717 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7718 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7719 assert_eq!(node_txn[0].output.len(), 1);
7720 check_spends!(node_txn[0], revoked_txn[0]);
7721 penalty_2 = node_txn[0].txid();
7722 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7723 assert_ne!(penalty_2, penalty_1);
7724 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7725 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7726 // Verify 25% bump heuristic
7727 assert!(feerate_2 * 100 >= feerate_1 * 125);
7731 assert_ne!(feerate_2, 0);
7733 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7734 connect_blocks(&nodes[1], 1);
7736 let mut feerate_3 = 0;
7738 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7739 assert_eq!(node_txn.len(), 1);
7740 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7741 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7742 assert_eq!(node_txn[0].output.len(), 1);
7743 check_spends!(node_txn[0], revoked_txn[0]);
7744 penalty_3 = node_txn[0].txid();
7745 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7746 assert_ne!(penalty_3, penalty_2);
7747 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7748 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7749 // Verify 25% bump heuristic
7750 assert!(feerate_3 * 100 >= feerate_2 * 125);
7754 assert_ne!(feerate_3, 0);
7756 nodes[1].node.get_and_clear_pending_events();
7757 nodes[1].node.get_and_clear_pending_msg_events();
7761 fn test_bump_penalty_txn_on_revoked_htlcs() {
7762 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7763 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7765 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7766 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7767 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7768 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7769 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7771 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7772 // Lock HTLC in both directions
7773 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7774 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7776 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7777 assert_eq!(revoked_local_txn[0].input.len(), 1);
7778 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7780 // Revoke local commitment tx
7781 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7783 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7784 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7785 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7786 check_closed_broadcast!(nodes[1], true);
7787 check_added_monitors!(nodes[1], 1);
7789 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7790 assert_eq!(revoked_htlc_txn.len(), 4);
7791 if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7792 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7793 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7794 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7795 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7796 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7797 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7798 } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7799 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7800 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7801 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7802 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7803 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7804 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7807 // Broadcast set of revoked txn on A
7808 let hash_128 = connect_blocks(&nodes[0], 40);
7809 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7810 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7811 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7812 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] });
7813 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7818 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7819 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7820 // Verify claim tx are spending revoked HTLC txn
7822 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7823 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7824 // which are included in the same block (they are broadcasted because we scan the
7825 // transactions linearly and generate claims as we go, they likely should be removed in the
7827 assert_eq!(node_txn[0].input.len(), 1);
7828 check_spends!(node_txn[0], revoked_local_txn[0]);
7829 assert_eq!(node_txn[1].input.len(), 1);
7830 check_spends!(node_txn[1], revoked_local_txn[0]);
7831 assert_eq!(node_txn[2].input.len(), 1);
7832 check_spends!(node_txn[2], revoked_local_txn[0]);
7834 // Each of the three justice transactions claim a separate (single) output of the three
7835 // available, which we check here:
7836 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7837 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7838 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7840 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7841 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7843 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7844 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7845 // a remote commitment tx has already been confirmed).
7846 check_spends!(node_txn[3], chan.3);
7848 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7849 // output, checked above).
7850 assert_eq!(node_txn[4].input.len(), 2);
7851 assert_eq!(node_txn[4].output.len(), 1);
7852 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7854 first = node_txn[4].txid();
7855 // Store both feerates for later comparison
7856 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7857 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7858 penalty_txn = vec![node_txn[2].clone()];
7862 // Connect one more block to see if bumped penalty are issued for HTLC txn
7863 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7864 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7865 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7866 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7868 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7869 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7871 check_spends!(node_txn[0], revoked_local_txn[0]);
7872 check_spends!(node_txn[1], revoked_local_txn[0]);
7873 // Note that these are both bogus - they spend outputs already claimed in block 129:
7874 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
7875 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7877 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7878 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7884 // Few more blocks to confirm penalty txn
7885 connect_blocks(&nodes[0], 4);
7886 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7887 let header_144 = connect_blocks(&nodes[0], 9);
7889 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7890 assert_eq!(node_txn.len(), 1);
7892 assert_eq!(node_txn[0].input.len(), 2);
7893 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7894 // Verify bumped tx is different and 25% bump heuristic
7895 assert_ne!(first, node_txn[0].txid());
7896 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7897 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7898 assert!(feerate_2 * 100 > feerate_1 * 125);
7899 let txn = vec![node_txn[0].clone()];
7903 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7904 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7905 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
7906 connect_blocks(&nodes[0], 20);
7908 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7909 // We verify than no new transaction has been broadcast because previously
7910 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7911 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7912 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7913 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7914 // up bumped justice generation.
7915 assert_eq!(node_txn.len(), 0);
7918 check_closed_broadcast!(nodes[0], true);
7919 check_added_monitors!(nodes[0], 1);
7923 fn test_bump_penalty_txn_on_remote_commitment() {
7924 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7925 // we're able to claim outputs on remote commitment transaction before timelocks expiration
7928 // Provide preimage for one
7929 // Check aggregation
7931 let chanmon_cfgs = create_chanmon_cfgs(2);
7932 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7933 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7934 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7936 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7937 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7938 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7940 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7941 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7942 assert_eq!(remote_txn[0].output.len(), 4);
7943 assert_eq!(remote_txn[0].input.len(), 1);
7944 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7946 // Claim a HTLC without revocation (provide B monitor with preimage)
7947 nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7948 mine_transaction(&nodes[1], &remote_txn[0]);
7949 check_added_monitors!(nodes[1], 2);
7951 // One or more claim tx should have been broadcast, check it
7954 let feerate_timeout;
7955 let feerate_preimage;
7957 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7958 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7959 assert_eq!(node_txn[0].input.len(), 1);
7960 assert_eq!(node_txn[1].input.len(), 1);
7961 check_spends!(node_txn[0], remote_txn[0]);
7962 check_spends!(node_txn[1], remote_txn[0]);
7963 check_spends!(node_txn[2], chan.3);
7964 check_spends!(node_txn[3], node_txn[2]);
7965 check_spends!(node_txn[4], node_txn[2]);
7966 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7967 timeout = node_txn[0].txid();
7968 let index = node_txn[0].input[0].previous_output.vout;
7969 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7970 feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7972 preimage = node_txn[1].txid();
7973 let index = node_txn[1].input[0].previous_output.vout;
7974 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7975 feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7977 timeout = node_txn[1].txid();
7978 let index = node_txn[1].input[0].previous_output.vout;
7979 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7980 feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7982 preimage = node_txn[0].txid();
7983 let index = node_txn[0].input[0].previous_output.vout;
7984 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7985 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7989 assert_ne!(feerate_timeout, 0);
7990 assert_ne!(feerate_preimage, 0);
7992 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7993 connect_blocks(&nodes[1], 15);
7995 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7996 assert_eq!(node_txn.len(), 2);
7997 assert_eq!(node_txn[0].input.len(), 1);
7998 assert_eq!(node_txn[1].input.len(), 1);
7999 check_spends!(node_txn[0], remote_txn[0]);
8000 check_spends!(node_txn[1], remote_txn[0]);
8001 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8002 let index = node_txn[0].input[0].previous_output.vout;
8003 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8004 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8005 assert!(new_feerate * 100 > feerate_timeout * 125);
8006 assert_ne!(timeout, node_txn[0].txid());
8008 let index = node_txn[1].input[0].previous_output.vout;
8009 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8010 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8011 assert!(new_feerate * 100 > feerate_preimage * 125);
8012 assert_ne!(preimage, node_txn[1].txid());
8014 let index = node_txn[1].input[0].previous_output.vout;
8015 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8016 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8017 assert!(new_feerate * 100 > feerate_timeout * 125);
8018 assert_ne!(timeout, node_txn[1].txid());
8020 let index = node_txn[0].input[0].previous_output.vout;
8021 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8022 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8023 assert!(new_feerate * 100 > feerate_preimage * 125);
8024 assert_ne!(preimage, node_txn[0].txid());
8029 nodes[1].node.get_and_clear_pending_events();
8030 nodes[1].node.get_and_clear_pending_msg_events();
8034 fn test_counterparty_raa_skip_no_crash() {
8035 // Previously, if our counterparty sent two RAAs in a row without us having provided a
8036 // commitment transaction, we would have happily carried on and provided them the next
8037 // commitment transaction based on one RAA forward. This would probably eventually have led to
8038 // channel closure, but it would not have resulted in funds loss. Still, our
8039 // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
8040 // check simply that the channel is closed in response to such an RAA, but don't check whether
8041 // we decide to punish our counterparty for revoking their funds (as we don't currently
8043 let chanmon_cfgs = create_chanmon_cfgs(2);
8044 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8045 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8046 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8047 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8049 let mut guard = nodes[0].node.channel_state.lock().unwrap();
8050 let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8051 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8052 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8053 // Must revoke without gaps
8054 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8055 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8056 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8058 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8059 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8060 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8061 check_added_monitors!(nodes[1], 1);
8065 fn test_bump_txn_sanitize_tracking_maps() {
8066 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8067 // verify we clean then right after expiration of ANTI_REORG_DELAY.
8069 let chanmon_cfgs = create_chanmon_cfgs(2);
8070 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8071 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8072 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8074 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8075 // Lock HTLC in both directions
8076 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8077 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8079 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8080 assert_eq!(revoked_local_txn[0].input.len(), 1);
8081 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8083 // Revoke local commitment tx
8084 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8086 // Broadcast set of revoked txn on A
8087 connect_blocks(&nodes[0], 52 - CHAN_CONFIRM_DEPTH);
8088 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8089 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8091 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8092 check_closed_broadcast!(nodes[0], true);
8093 check_added_monitors!(nodes[0], 1);
8095 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8096 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8097 check_spends!(node_txn[0], revoked_local_txn[0]);
8098 check_spends!(node_txn[1], revoked_local_txn[0]);
8099 check_spends!(node_txn[2], revoked_local_txn[0]);
8100 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8104 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8105 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8106 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8108 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8109 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8110 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8111 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8117 fn test_override_channel_config() {
8118 let chanmon_cfgs = create_chanmon_cfgs(2);
8119 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8120 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8121 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8123 // Node0 initiates a channel to node1 using the override config.
8124 let mut override_config = UserConfig::default();
8125 override_config.own_channel_config.our_to_self_delay = 200;
8127 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8129 // Assert the channel created by node0 is using the override config.
8130 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8131 assert_eq!(res.channel_flags, 0);
8132 assert_eq!(res.to_self_delay, 200);
8136 fn test_override_0msat_htlc_minimum() {
8137 let mut zero_config = UserConfig::default();
8138 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8139 let chanmon_cfgs = create_chanmon_cfgs(2);
8140 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8141 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8142 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8144 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8145 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8146 assert_eq!(res.htlc_minimum_msat, 1);
8148 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8149 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8150 assert_eq!(res.htlc_minimum_msat, 1);
8154 fn test_simple_payment_secret() {
8155 // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8156 // features, however.
8157 let chanmon_cfgs = create_chanmon_cfgs(3);
8158 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8159 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8160 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8162 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8163 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8164 let logger = test_utils::TestLogger::new();
8166 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8167 let payment_secret = PaymentSecret([0xdb; 32]);
8168 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8169 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8170 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8171 // Claiming with all the correct values but the wrong secret should result in nothing...
8172 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8173 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8174 // ...but with the right secret we should be able to claim all the way back
8175 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8179 fn test_simple_mpp() {
8180 // Simple test of sending a multi-path payment.
8181 let chanmon_cfgs = create_chanmon_cfgs(4);
8182 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8183 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8184 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8186 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8187 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8188 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8189 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8190 let logger = test_utils::TestLogger::new();
8192 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8193 let payment_secret = PaymentSecret([0xdb; 32]);
8194 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8195 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3].node.get_our_node_id(), None, None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8196 let path = route.paths[0].clone();
8197 route.paths.push(path);
8198 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8199 route.paths[0][0].short_channel_id = chan_1_id;
8200 route.paths[0][1].short_channel_id = chan_3_id;
8201 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8202 route.paths[1][0].short_channel_id = chan_2_id;
8203 route.paths[1][1].short_channel_id = chan_4_id;
8204 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8205 // Claiming with all the correct values but the wrong secret should result in nothing...
8206 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8207 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8208 // ...but with the right secret we should be able to claim all the way back
8209 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8213 fn test_update_err_monitor_lockdown() {
8214 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8215 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8216 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8218 // This scenario may happen in a watchtower setup, where watchtower process a block height
8219 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8220 // commitment at same time.
8222 let chanmon_cfgs = create_chanmon_cfgs(2);
8223 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8224 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8225 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8227 // Create some initial channel
8228 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8229 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8231 // Rebalance the network to generate htlc in the two directions
8232 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8234 // Route a HTLC from node 0 to node 1 (but don't settle)
8235 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8237 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8238 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8239 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8240 let persister = test_utils::TestPersister::new();
8242 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8243 let monitor = monitors.get(&outpoint).unwrap();
8244 let mut w = test_utils::TestVecWriter(Vec::new());
8245 monitor.write(&mut w).unwrap();
8246 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8247 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8248 assert!(new_monitor == *monitor);
8249 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);
8250 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8253 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8254 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8256 // Try to update ChannelMonitor
8257 assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8258 check_added_monitors!(nodes[1], 1);
8259 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8260 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8261 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8262 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8263 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8264 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8265 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8266 } else { assert!(false); }
8267 } else { assert!(false); };
8268 // Our local monitor is in-sync and hasn't processed yet timeout
8269 check_added_monitors!(nodes[0], 1);
8270 let events = nodes[0].node.get_and_clear_pending_events();
8271 assert_eq!(events.len(), 1);
8275 fn test_concurrent_monitor_claim() {
8276 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8277 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8278 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8279 // state N+1 confirms. Alice claims output from state N+1.
8281 let chanmon_cfgs = create_chanmon_cfgs(2);
8282 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8283 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8284 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8286 // Create some initial channel
8287 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8288 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8290 // Rebalance the network to generate htlc in the two directions
8291 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8293 // Route a HTLC from node 0 to node 1 (but don't settle)
8294 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8296 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8297 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8298 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8299 let persister = test_utils::TestPersister::new();
8300 let watchtower_alice = {
8301 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8302 let monitor = monitors.get(&outpoint).unwrap();
8303 let mut w = test_utils::TestVecWriter(Vec::new());
8304 monitor.write(&mut w).unwrap();
8305 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8306 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8307 assert!(new_monitor == *monitor);
8308 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);
8309 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8312 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8313 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8315 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8317 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8318 assert_eq!(txn.len(), 2);
8322 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8323 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8324 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8325 let persister = test_utils::TestPersister::new();
8326 let watchtower_bob = {
8327 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8328 let monitor = monitors.get(&outpoint).unwrap();
8329 let mut w = test_utils::TestVecWriter(Vec::new());
8330 monitor.write(&mut w).unwrap();
8331 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8332 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8333 assert!(new_monitor == *monitor);
8334 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);
8335 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8338 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8339 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8341 // Route another payment to generate another update with still previous HTLC pending
8342 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
8344 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8345 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8346 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
8348 check_added_monitors!(nodes[1], 1);
8350 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8351 assert_eq!(updates.update_add_htlcs.len(), 1);
8352 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8353 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8354 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8355 // Watchtower Alice should already have seen the block and reject the update
8356 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8357 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8358 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8359 } else { assert!(false); }
8360 } else { assert!(false); };
8361 // Our local monitor is in-sync and hasn't processed yet timeout
8362 check_added_monitors!(nodes[0], 1);
8364 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8365 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8366 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8368 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8371 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8372 assert_eq!(txn.len(), 2);
8373 bob_state_y = txn[0].clone();
8377 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8378 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8379 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);
8381 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8382 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8383 // the onchain detection of the HTLC output
8384 assert_eq!(htlc_txn.len(), 2);
8385 check_spends!(htlc_txn[0], bob_state_y);
8386 check_spends!(htlc_txn[1], bob_state_y);
8391 fn test_pre_lockin_no_chan_closed_update() {
8392 // Test that if a peer closes a channel in response to a funding_created message we don't
8393 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8396 // Doing so would imply a channel monitor update before the initial channel monitor
8397 // registration, violating our API guarantees.
8399 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8400 // then opening a second channel with the same funding output as the first (which is not
8401 // rejected because the first channel does not exist in the ChannelManager) and closing it
8402 // before receiving funding_signed.
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 an initial channel
8409 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8410 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8411 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8412 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8413 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8415 // Move the first channel through the funding flow...
8416 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8418 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8419 check_added_monitors!(nodes[0], 0);
8421 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8422 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8423 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8424 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8428 fn test_htlc_no_detection() {
8429 // This test is a mutation to underscore the detection logic bug we had
8430 // before #653. HTLC value routed is above the remaining balance, thus
8431 // inverting HTLC and `to_remote` output. HTLC will come second and
8432 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8433 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8434 // outputs order detection for correct spending children filtring.
8436 let chanmon_cfgs = create_chanmon_cfgs(2);
8437 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8438 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8439 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8441 // Create some initial channels
8442 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8444 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000, 1_000_000);
8445 let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8446 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8447 assert_eq!(local_txn[0].input.len(), 1);
8448 assert_eq!(local_txn[0].output.len(), 3);
8449 check_spends!(local_txn[0], chan_1.3);
8451 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8452 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8453 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8454 // We deliberately connect the local tx twice as this should provoke a failure calling
8455 // this test before #653 fix.
8456 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);
8457 check_closed_broadcast!(nodes[0], true);
8458 check_added_monitors!(nodes[0], 1);
8460 let htlc_timeout = {
8461 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8462 assert_eq!(node_txn[0].input.len(), 1);
8463 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8464 check_spends!(node_txn[0], local_txn[0]);
8468 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8469 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8470 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8471 expect_payment_failed!(nodes[0], our_payment_hash, true);
8474 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8475 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8476 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8477 // Carol, Alice would be the upstream node, and Carol the downstream.)
8479 // Steps of the test:
8480 // 1) Alice sends a HTLC to Carol through Bob.
8481 // 2) Carol doesn't settle the HTLC.
8482 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8483 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8484 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8485 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8486 // 5) Carol release the preimage to Bob off-chain.
8487 // 6) Bob claims the offered output on the broadcasted commitment.
8488 let chanmon_cfgs = create_chanmon_cfgs(3);
8489 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8490 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8491 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8493 // Create some initial channels
8494 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8495 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8497 // Steps (1) and (2):
8498 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8499 let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8501 // Check that Alice's commitment transaction now contains an output for this HTLC.
8502 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8503 check_spends!(alice_txn[0], chan_ab.3);
8504 assert_eq!(alice_txn[0].output.len(), 2);
8505 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8506 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8507 assert_eq!(alice_txn.len(), 2);
8509 // Steps (3) and (4):
8510 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8511 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8512 let mut force_closing_node = 0; // Alice force-closes
8513 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8514 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8515 check_closed_broadcast!(nodes[force_closing_node], true);
8516 check_added_monitors!(nodes[force_closing_node], 1);
8517 if go_onchain_before_fulfill {
8518 let txn_to_broadcast = match broadcast_alice {
8519 true => alice_txn.clone(),
8520 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8522 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8523 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8524 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8525 if broadcast_alice {
8526 check_closed_broadcast!(nodes[1], true);
8527 check_added_monitors!(nodes[1], 1);
8529 assert_eq!(bob_txn.len(), 1);
8530 check_spends!(bob_txn[0], chan_ab.3);
8534 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8535 // process of removing the HTLC from their commitment transactions.
8536 assert!(nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000));
8537 check_added_monitors!(nodes[2], 1);
8538 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8539 assert!(carol_updates.update_add_htlcs.is_empty());
8540 assert!(carol_updates.update_fail_htlcs.is_empty());
8541 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8542 assert!(carol_updates.update_fee.is_none());
8543 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8545 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8546 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8547 if !go_onchain_before_fulfill && broadcast_alice {
8548 let events = nodes[1].node.get_and_clear_pending_msg_events();
8549 assert_eq!(events.len(), 1);
8551 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8552 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8554 _ => panic!("Unexpected event"),
8557 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8558 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8559 // Carol<->Bob's updated commitment transaction info.
8560 check_added_monitors!(nodes[1], 2);
8562 let events = nodes[1].node.get_and_clear_pending_msg_events();
8563 assert_eq!(events.len(), 2);
8564 let bob_revocation = match events[0] {
8565 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8566 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8569 _ => panic!("Unexpected event"),
8571 let bob_updates = match events[1] {
8572 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8573 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8576 _ => panic!("Unexpected event"),
8579 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8580 check_added_monitors!(nodes[2], 1);
8581 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8582 check_added_monitors!(nodes[2], 1);
8584 let events = nodes[2].node.get_and_clear_pending_msg_events();
8585 assert_eq!(events.len(), 1);
8586 let carol_revocation = match events[0] {
8587 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8588 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8591 _ => panic!("Unexpected event"),
8593 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8594 check_added_monitors!(nodes[1], 1);
8596 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8597 // here's where we put said channel's commitment tx on-chain.
8598 let mut txn_to_broadcast = alice_txn.clone();
8599 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8600 if !go_onchain_before_fulfill {
8601 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8602 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8603 // If Bob was the one to force-close, he will have already passed these checks earlier.
8604 if broadcast_alice {
8605 check_closed_broadcast!(nodes[1], true);
8606 check_added_monitors!(nodes[1], 1);
8608 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8609 if broadcast_alice {
8610 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8611 // new block being connected. The ChannelManager being notified triggers a monitor update,
8612 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8613 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8615 assert_eq!(bob_txn.len(), 3);
8616 check_spends!(bob_txn[1], chan_ab.3);
8618 assert_eq!(bob_txn.len(), 2);
8619 check_spends!(bob_txn[0], chan_ab.3);
8624 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8625 // broadcasted commitment transaction.
8627 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8628 if go_onchain_before_fulfill {
8629 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8630 assert_eq!(bob_txn.len(), 2);
8632 let script_weight = match broadcast_alice {
8633 true => OFFERED_HTLC_SCRIPT_WEIGHT,
8634 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8636 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8637 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8638 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8639 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8640 if broadcast_alice && !go_onchain_before_fulfill {
8641 check_spends!(bob_txn[0], txn_to_broadcast[0]);
8642 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8644 check_spends!(bob_txn[1], txn_to_broadcast[0]);
8645 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8651 fn test_onchain_htlc_settlement_after_close() {
8652 do_test_onchain_htlc_settlement_after_close(true, true);
8653 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8654 do_test_onchain_htlc_settlement_after_close(true, false);
8655 do_test_onchain_htlc_settlement_after_close(false, false);
8659 fn test_duplicate_chan_id() {
8660 // Test that if a given peer tries to open a channel with the same channel_id as one that is
8661 // already open we reject it and keep the old channel.
8663 // Previously, full_stack_target managed to figure out that if you tried to open two channels
8664 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8665 // the existing channel when we detect the duplicate new channel, screwing up our monitor
8666 // updating logic for the existing channel.
8667 let chanmon_cfgs = create_chanmon_cfgs(2);
8668 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8669 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8670 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8672 // Create an initial channel
8673 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8674 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8675 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8676 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()));
8678 // Try to create a second channel with the same temporary_channel_id as the first and check
8679 // that it is rejected.
8680 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8682 let events = nodes[1].node.get_and_clear_pending_msg_events();
8683 assert_eq!(events.len(), 1);
8685 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8686 // Technically, at this point, nodes[1] would be justified in thinking both the
8687 // first (valid) and second (invalid) channels are closed, given they both have
8688 // the same non-temporary channel_id. However, currently we do not, so we just
8689 // move forward with it.
8690 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8691 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8693 _ => panic!("Unexpected event"),
8697 // Move the first channel through the funding flow...
8698 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8700 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8701 check_added_monitors!(nodes[0], 0);
8703 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8704 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8706 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8707 assert_eq!(added_monitors.len(), 1);
8708 assert_eq!(added_monitors[0].0, funding_output);
8709 added_monitors.clear();
8711 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8713 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8714 let channel_id = funding_outpoint.to_channel_id();
8716 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8719 // First try to open a second channel with a temporary channel id equal to the txid-based one.
8720 // Technically this is allowed by the spec, but we don't support it and there's little reason
8721 // to. Still, it shouldn't cause any other issues.
8722 open_chan_msg.temporary_channel_id = channel_id;
8723 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8725 let events = nodes[1].node.get_and_clear_pending_msg_events();
8726 assert_eq!(events.len(), 1);
8728 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8729 // Technically, at this point, nodes[1] would be justified in thinking both
8730 // channels are closed, but currently we do not, so we just move forward with it.
8731 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8732 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8734 _ => panic!("Unexpected event"),
8738 // Now try to create a second channel which has a duplicate funding output.
8739 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8740 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8741 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8742 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8743 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8745 let funding_created = {
8746 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8747 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8748 let logger = test_utils::TestLogger::new();
8749 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8751 check_added_monitors!(nodes[0], 0);
8752 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8753 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8754 // still needs to be cleared here.
8755 check_added_monitors!(nodes[1], 1);
8757 // ...still, nodes[1] will reject the duplicate channel.
8759 let events = nodes[1].node.get_and_clear_pending_msg_events();
8760 assert_eq!(events.len(), 1);
8762 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8763 // Technically, at this point, nodes[1] would be justified in thinking both
8764 // channels are closed, but currently we do not, so we just move forward with it.
8765 assert_eq!(msg.channel_id, channel_id);
8766 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8768 _ => panic!("Unexpected event"),
8772 // finally, finish creating the original channel and send a payment over it to make sure
8773 // everything is functional.
8774 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8776 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8777 assert_eq!(added_monitors.len(), 1);
8778 assert_eq!(added_monitors[0].0, funding_output);
8779 added_monitors.clear();
8782 let events_4 = nodes[0].node.get_and_clear_pending_events();
8783 assert_eq!(events_4.len(), 0);
8784 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8785 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
8787 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8788 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8789 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8790 send_payment(&nodes[0], &[&nodes[1]], 8000000, 8_000_000);
8794 fn test_error_chans_closed() {
8795 // Test that we properly handle error messages, closing appropriate channels.
8797 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8798 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8799 // we can test various edge cases around it to ensure we don't regress.
8800 let chanmon_cfgs = create_chanmon_cfgs(3);
8801 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8802 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8803 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8805 // Create some initial channels
8806 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8807 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8808 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8810 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8811 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8812 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8814 // Closing a channel from a different peer has no effect
8815 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8816 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8818 // Closing one channel doesn't impact others
8819 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8820 check_added_monitors!(nodes[0], 1);
8821 check_closed_broadcast!(nodes[0], false);
8822 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
8823 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8824 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);
8825 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);
8827 // A null channel ID should close all channels
8828 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8829 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8830 check_added_monitors!(nodes[0], 2);
8831 let events = nodes[0].node.get_and_clear_pending_msg_events();
8832 assert_eq!(events.len(), 2);
8834 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8835 assert_eq!(msg.contents.flags & 2, 2);
8837 _ => panic!("Unexpected event"),
8840 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8841 assert_eq!(msg.contents.flags & 2, 2);
8843 _ => panic!("Unexpected event"),
8845 // Note that at this point users of a standard PeerHandler will end up calling
8846 // peer_disconnected with no_connection_possible set to false, duplicating the
8847 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8848 // users with their own peer handling logic. We duplicate the call here, however.
8849 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8850 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8852 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8853 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8854 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8858 fn test_invalid_funding_tx() {
8859 // Test that we properly handle invalid funding transactions sent to us from a peer.
8861 // Previously, all other major lightning implementations had failed to properly sanitize
8862 // funding transactions from their counterparties, leading to a multi-implementation critical
8863 // security vulnerability (though we always sanitized properly, we've previously had
8864 // un-released crashes in the sanitization process).
8865 let chanmon_cfgs = create_chanmon_cfgs(2);
8866 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8867 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8868 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8870 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
8871 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()));
8872 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()));
8874 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
8875 for output in tx.output.iter_mut() {
8876 // Make the confirmed funding transaction have a bogus script_pubkey
8877 output.script_pubkey = bitcoin::Script::new();
8880 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
8881 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()));
8882 check_added_monitors!(nodes[1], 1);
8884 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()));
8885 check_added_monitors!(nodes[0], 1);
8887 let events_1 = nodes[0].node.get_and_clear_pending_events();
8888 assert_eq!(events_1.len(), 0);
8890 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8891 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8892 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
8894 confirm_transaction_at(&nodes[1], &tx, 1);
8895 check_added_monitors!(nodes[1], 1);
8896 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
8897 assert_eq!(events_2.len(), 1);
8898 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
8899 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8900 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
8901 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
8902 } else { panic!(); }
8903 } else { panic!(); }
8904 assert_eq!(nodes[1].node.list_channels().len(), 0);