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, InvoiceFeatures, 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, our_payment_secret) = 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, our_payment_secret) = 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(), Some(InvoiceFeatures::known()), 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, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
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(), Some(InvoiceFeatures::known()), 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, payment_secret) = 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(), Some(InvoiceFeatures::known()), 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(), Some(InvoiceFeatures::known()), 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, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
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(), Some(InvoiceFeatures::known()), 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, _, our_payment_secret) = 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::known(),
1224 short_channel_id: chan_4.0.contents.short_channel_id,
1225 channel_features: ChannelFeatures::known(),
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::known(),
1253 short_channel_id: chan_2.0.contents.short_channel_id,
1254 channel_features: ChannelFeatures::known(),
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, payment_secret) = get_payment_preimage_hash!(nodes[2]);
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(), Some(InvoiceFeatures::known()), 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, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
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(), Some(InvoiceFeatures::known()), 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, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
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(), Some(InvoiceFeatures::known()), 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, payment_secret) = 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(), Some(InvoiceFeatures::known()), 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, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
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(), Some(InvoiceFeatures::known()), 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());
1573 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1574 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1575 let secp_ctx = Secp256k1::new();
1576 let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1578 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1580 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1581 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1582 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1583 let msg = msgs::UpdateAddHTLC {
1586 amount_msat: htlc_msat,
1587 payment_hash: payment_hash,
1588 cltv_expiry: htlc_cltv,
1589 onion_routing_packet: onion_packet,
1592 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1594 // Now manually create the commitment_signed message corresponding to the update_add
1595 // nodes[0] just sent. In the code for construction of this message, "local" refers
1596 // to the sender of the message, and "remote" refers to the receiver.
1598 let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1600 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1602 // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1603 // needed to sign the new commitment tx and (2) sign the new commitment tx.
1604 let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1605 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1606 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1607 let chan_signer = local_chan.get_signer();
1608 let pubkeys = chan_signer.pubkeys();
1609 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1610 chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1611 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1613 let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1614 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1615 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1616 let chan_signer = remote_chan.get_signer();
1617 let pubkeys = chan_signer.pubkeys();
1618 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1619 chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1622 // Assemble the set of keys we can use for signatures for our commitment_signed message.
1623 let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1624 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1626 // Build the remote commitment transaction so we can sign it, and then later use the
1627 // signature for the commitment_signed message.
1628 let local_chan_balance = 1313;
1630 let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1632 amount_msat: 3460001,
1633 cltv_expiry: htlc_cltv,
1635 transaction_output_index: Some(1),
1638 let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1641 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1642 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1643 let local_chan_signer = local_chan.get_signer();
1644 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1648 commit_tx_keys.clone(),
1650 &mut vec![(accepted_htlc_info, ())],
1651 &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1653 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1656 let commit_signed_msg = msgs::CommitmentSigned {
1659 htlc_signatures: res.1
1662 // Send the commitment_signed message to the nodes[1].
1663 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1664 let _ = nodes[1].node.get_and_clear_pending_msg_events();
1666 // Send the RAA to nodes[1].
1667 let raa_msg = msgs::RevokeAndACK {
1669 per_commitment_secret: local_secret,
1670 next_per_commitment_point: next_local_point
1672 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1674 let events = nodes[1].node.get_and_clear_pending_msg_events();
1675 assert_eq!(events.len(), 1);
1676 // Make sure the HTLC failed in the way we expect.
1678 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1679 assert_eq!(update_fail_htlcs.len(), 1);
1680 update_fail_htlcs[0].clone()
1682 _ => panic!("Unexpected event"),
1684 nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1686 check_added_monitors!(nodes[1], 2);
1690 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1691 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1692 // Set the fee rate for the channel very high, to the point where the fundee
1693 // sending any above-dust amount would result in a channel reserve violation.
1694 // In this test we check that we would be prevented from sending an HTLC in
1696 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1697 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1698 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1699 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1700 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1701 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1703 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1704 unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1705 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1706 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1707 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);
1711 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1712 let mut chanmon_cfgs = create_chanmon_cfgs(2);
1713 // Set the fee rate for the channel very high, to the point where the funder
1714 // receiving 1 update_add_htlc would result in them closing the channel due
1715 // to channel reserve violation. This close could also happen if the fee went
1716 // up a more realistic amount, but many HTLCs were outstanding at the time of
1717 // the update_add_htlc.
1718 chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1719 chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1720 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1721 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1722 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1723 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1725 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1726 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1727 let secp_ctx = Secp256k1::new();
1728 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1729 let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1730 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1731 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1732 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1733 let msg = msgs::UpdateAddHTLC {
1736 amount_msat: htlc_msat + 1,
1737 payment_hash: payment_hash,
1738 cltv_expiry: htlc_cltv,
1739 onion_routing_packet: onion_packet,
1742 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1743 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1744 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);
1745 assert_eq!(nodes[0].node.list_channels().len(), 0);
1746 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1747 assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1748 check_added_monitors!(nodes[0], 1);
1752 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1753 // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1754 // calculating our commitment transaction fee (this was previously broken).
1755 let chanmon_cfgs = create_chanmon_cfgs(2);
1756 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1757 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1758 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1760 // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1761 // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1762 // transaction fee with 0 HTLCs (183 sats)).
1763 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1765 let dust_amt = 546000; // Dust amount
1766 // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1767 // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1768 // commitment transaction fee.
1769 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1773 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1774 // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1775 // calculating our counterparty's commitment transaction fee (this was previously broken).
1776 let chanmon_cfgs = create_chanmon_cfgs(2);
1777 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1778 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1779 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1780 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1782 let payment_amt = 46000; // Dust amount
1783 // In the previous code, these first four payments would succeed.
1784 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1785 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1786 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1787 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1789 // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1790 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1791 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1792 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1793 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1794 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1796 // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1797 // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1798 // transaction fee and therefore perceived this next payment as a channel reserve violation.
1799 let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1803 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1804 let chanmon_cfgs = create_chanmon_cfgs(3);
1805 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1806 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1807 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1808 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1809 let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1812 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1813 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1814 let feerate = get_feerate!(nodes[0], chan.2);
1816 // Add a 2* and +1 for the fee spike reserve.
1817 let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1818 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;
1819 let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1821 // Add a pending HTLC.
1822 let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1823 let payment_event_1 = {
1824 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1825 check_added_monitors!(nodes[0], 1);
1827 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1828 assert_eq!(events.len(), 1);
1829 SendEvent::from_event(events.remove(0))
1831 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1833 // Attempt to trigger a channel reserve violation --> payment failure.
1834 let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1835 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;
1836 let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1837 let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1839 // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1840 let secp_ctx = Secp256k1::new();
1841 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1842 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1843 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1844 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1845 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1846 let msg = msgs::UpdateAddHTLC {
1849 amount_msat: htlc_msat + 1,
1850 payment_hash: our_payment_hash_1,
1851 cltv_expiry: htlc_cltv,
1852 onion_routing_packet: onion_packet,
1855 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1856 // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1857 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1858 assert_eq!(nodes[1].node.list_channels().len(), 1);
1859 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1860 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1861 check_added_monitors!(nodes[1], 1);
1865 fn test_inbound_outbound_capacity_is_not_zero() {
1866 let chanmon_cfgs = create_chanmon_cfgs(2);
1867 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1868 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1869 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1870 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1871 let channels0 = node_chanmgrs[0].list_channels();
1872 let channels1 = node_chanmgrs[1].list_channels();
1873 assert_eq!(channels0.len(), 1);
1874 assert_eq!(channels1.len(), 1);
1876 assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1877 assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1879 assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1880 assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1883 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1884 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1888 fn test_channel_reserve_holding_cell_htlcs() {
1889 let chanmon_cfgs = create_chanmon_cfgs(3);
1890 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1891 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1892 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1893 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1894 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1896 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1897 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1899 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1900 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1902 macro_rules! expect_forward {
1904 let mut events = $node.node.get_and_clear_pending_msg_events();
1905 assert_eq!(events.len(), 1);
1906 check_added_monitors!($node, 1);
1907 let payment_event = SendEvent::from_event(events.remove(0));
1912 let feemsat = 239; // somehow we know?
1913 let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1914 let feerate = get_feerate!(nodes[0], chan_1.2);
1916 let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1918 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1920 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1921 route.paths[0].last_mut().unwrap().fee_msat += 1;
1922 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1923 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1924 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)));
1925 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1926 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);
1929 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1930 // nodes[0]'s wealth
1932 let amt_msat = recv_value_0 + total_fee_msat;
1933 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1934 // Also, ensure that each payment has enough to be over the dust limit to
1935 // ensure it'll be included in each commit tx fee calculation.
1936 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1937 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1938 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1941 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1943 let (stat01_, stat11_, stat12_, stat22_) = (
1944 get_channel_value_stat!(nodes[0], chan_1.2),
1945 get_channel_value_stat!(nodes[1], chan_1.2),
1946 get_channel_value_stat!(nodes[1], chan_2.2),
1947 get_channel_value_stat!(nodes[2], chan_2.2),
1950 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1951 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1952 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1953 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1954 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1957 // adding pending output.
1958 // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1959 // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1960 // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1961 // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1962 // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1963 // cases where 1 msat over X amount will cause a payment failure, but anything less than
1964 // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1965 // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1966 // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1968 let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1969 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1970 let amt_msat_1 = recv_value_1 + total_fee_msat;
1972 let (route_1, our_payment_hash_1, our_payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_1);
1973 let payment_event_1 = {
1974 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1975 check_added_monitors!(nodes[0], 1);
1977 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1978 assert_eq!(events.len(), 1);
1979 SendEvent::from_event(events.remove(0))
1981 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1983 // channel reserve test with htlc pending output > 0
1984 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1986 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1987 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1988 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1989 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1992 // split the rest to test holding cell
1993 let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1994 let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1995 let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1996 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1998 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1999 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);
2002 // now see if they go through on both sides
2003 let (route_21, our_payment_hash_21, our_payment_preimage_21, our_payment_secret_21) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_21);
2004 // but this will stuck in the holding cell
2005 nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2006 check_added_monitors!(nodes[0], 0);
2007 let events = nodes[0].node.get_and_clear_pending_events();
2008 assert_eq!(events.len(), 0);
2010 // test with outbound holding cell amount > 0
2012 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2013 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2014 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2015 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2016 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);
2019 let (route_22, our_payment_hash_22, our_payment_preimage_22, our_payment_secret_22) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22);
2020 // this will also stuck in the holding cell
2021 nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2022 check_added_monitors!(nodes[0], 0);
2023 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2024 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2026 // flush the pending htlc
2027 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2028 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2029 check_added_monitors!(nodes[1], 1);
2031 // the pending htlc should be promoted to committed
2032 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2033 check_added_monitors!(nodes[0], 1);
2034 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2036 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2037 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2038 // No commitment_signed so get_event_msg's assert(len == 1) passes
2039 check_added_monitors!(nodes[0], 1);
2041 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2042 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2043 check_added_monitors!(nodes[1], 1);
2045 expect_pending_htlcs_forwardable!(nodes[1]);
2047 let ref payment_event_11 = expect_forward!(nodes[1]);
2048 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2049 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2051 expect_pending_htlcs_forwardable!(nodes[2]);
2052 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2054 // flush the htlcs in the holding cell
2055 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2056 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2057 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2058 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2059 expect_pending_htlcs_forwardable!(nodes[1]);
2061 let ref payment_event_3 = expect_forward!(nodes[1]);
2062 assert_eq!(payment_event_3.msgs.len(), 2);
2063 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2064 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2066 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2067 expect_pending_htlcs_forwardable!(nodes[2]);
2069 let events = nodes[2].node.get_and_clear_pending_events();
2070 assert_eq!(events.len(), 2);
2072 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2073 assert_eq!(our_payment_hash_21, *payment_hash);
2074 assert_eq!(*payment_secret, None);
2075 assert_eq!(recv_value_21, amt);
2077 _ => panic!("Unexpected event"),
2080 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2081 assert_eq!(our_payment_hash_22, *payment_hash);
2082 assert_eq!(None, *payment_secret);
2083 assert_eq!(recv_value_22, amt);
2085 _ => panic!("Unexpected event"),
2088 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2089 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2090 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2092 let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2093 let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2094 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2096 let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2097 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);
2098 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2099 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2100 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2102 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2103 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2107 fn channel_reserve_in_flight_removes() {
2108 // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2109 // can send to its counterparty, but due to update ordering, the other side may not yet have
2110 // considered those HTLCs fully removed.
2111 // This tests that we don't count HTLCs which will not be included in the next remote
2112 // commitment transaction towards the reserve value (as it implies no commitment transaction
2113 // will be generated which violates the remote reserve value).
2114 // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2116 // * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2117 // you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2118 // you only consider the value of the first HTLC, it may not),
2119 // * start routing a third HTLC from A to B,
2120 // * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2121 // the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2122 // * deliver the first fulfill from B
2123 // * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2125 // * deliver A's response CS and RAA.
2126 // This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2127 // removed it fully. B now has the push_msat plus the first two HTLCs in value.
2128 // * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2129 // of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2130 let chanmon_cfgs = create_chanmon_cfgs(2);
2131 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2132 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2133 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2134 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2135 let logger = test_utils::TestLogger::new();
2137 let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2138 // Route the first two HTLCs.
2139 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2140 let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2142 // Start routing the third HTLC (this is just used to get everyone in the right state).
2143 let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2145 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2146 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2147 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2148 check_added_monitors!(nodes[0], 1);
2149 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2150 assert_eq!(events.len(), 1);
2151 SendEvent::from_event(events.remove(0))
2154 // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2155 // initial fulfill/CS.
2156 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2157 check_added_monitors!(nodes[1], 1);
2158 let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2160 // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2161 // remove the second HTLC when we send the HTLC back from B to A.
2162 assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2163 check_added_monitors!(nodes[1], 1);
2164 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2166 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2167 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2168 check_added_monitors!(nodes[0], 1);
2169 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2170 expect_payment_sent!(nodes[0], payment_preimage_1);
2172 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2173 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2174 check_added_monitors!(nodes[1], 1);
2175 // B is already AwaitingRAA, so cant generate a CS here
2176 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2178 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2179 check_added_monitors!(nodes[1], 1);
2180 let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2182 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2183 check_added_monitors!(nodes[0], 1);
2184 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2186 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2187 check_added_monitors!(nodes[1], 1);
2188 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2190 // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2191 // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2192 // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2193 // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2194 // on-chain as necessary).
2195 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2196 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2197 check_added_monitors!(nodes[0], 1);
2198 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2199 expect_payment_sent!(nodes[0], payment_preimage_2);
2201 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2202 check_added_monitors!(nodes[1], 1);
2203 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2205 expect_pending_htlcs_forwardable!(nodes[1]);
2206 expect_payment_received!(nodes[1], payment_hash_3, 100000);
2208 // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2209 // resolve the second HTLC from A's point of view.
2210 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2211 check_added_monitors!(nodes[0], 1);
2212 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2214 // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2215 // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2216 let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2218 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2219 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2220 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2221 check_added_monitors!(nodes[1], 1);
2222 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2223 assert_eq!(events.len(), 1);
2224 SendEvent::from_event(events.remove(0))
2227 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2228 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2229 check_added_monitors!(nodes[0], 1);
2230 let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2232 // Now just resolve all the outstanding messages/HTLCs for completeness...
2234 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2235 check_added_monitors!(nodes[1], 1);
2236 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2238 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2239 check_added_monitors!(nodes[1], 1);
2241 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2242 check_added_monitors!(nodes[0], 1);
2243 let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2245 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2246 check_added_monitors!(nodes[1], 1);
2247 let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2249 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2250 check_added_monitors!(nodes[0], 1);
2252 expect_pending_htlcs_forwardable!(nodes[0]);
2253 expect_payment_received!(nodes[0], payment_hash_4, 10000);
2255 claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2256 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2260 fn channel_monitor_network_test() {
2261 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2262 // tests that ChannelMonitor is able to recover from various states.
2263 let chanmon_cfgs = create_chanmon_cfgs(5);
2264 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2265 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2266 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2268 // Create some initial channels
2269 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2270 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2271 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2272 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2274 // Make sure all nodes are at the same starting height
2275 connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2276 connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2277 connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2278 connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2279 connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2281 // Rebalance the network a bit by relaying one payment through all the channels...
2282 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2283 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2284 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2285 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2287 // Simple case with no pending HTLCs:
2288 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2289 check_added_monitors!(nodes[1], 1);
2290 check_closed_broadcast!(nodes[1], false);
2292 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2293 assert_eq!(node_txn.len(), 1);
2294 mine_transaction(&nodes[0], &node_txn[0]);
2295 check_added_monitors!(nodes[0], 1);
2296 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2298 check_closed_broadcast!(nodes[0], true);
2299 assert_eq!(nodes[0].node.list_channels().len(), 0);
2300 assert_eq!(nodes[1].node.list_channels().len(), 1);
2302 // One pending HTLC is discarded by the force-close:
2303 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2305 // Simple case of one pending HTLC to HTLC-Timeout
2306 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2307 check_closed_broadcast!(nodes[1], false);
2308 check_added_monitors!(nodes[1], 1);
2310 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2311 mine_transaction(&nodes[2], &node_txn[0]);
2312 check_added_monitors!(nodes[2], 1);
2313 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2315 check_closed_broadcast!(nodes[2], true);
2316 assert_eq!(nodes[1].node.list_channels().len(), 0);
2317 assert_eq!(nodes[2].node.list_channels().len(), 1);
2319 macro_rules! claim_funds {
2320 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2322 assert!($node.node.claim_funds($preimage, &None, $amount));
2323 check_added_monitors!($node, 1);
2325 let events = $node.node.get_and_clear_pending_msg_events();
2326 assert_eq!(events.len(), 1);
2328 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2329 assert!(update_add_htlcs.is_empty());
2330 assert!(update_fail_htlcs.is_empty());
2331 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2333 _ => panic!("Unexpected event"),
2339 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2340 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2341 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2342 check_added_monitors!(nodes[2], 1);
2343 check_closed_broadcast!(nodes[2], false);
2344 let node2_commitment_txid;
2346 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2347 node2_commitment_txid = node_txn[0].txid();
2349 // Claim the payment on nodes[3], giving it knowledge of the preimage
2350 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2351 mine_transaction(&nodes[3], &node_txn[0]);
2352 check_added_monitors!(nodes[3], 1);
2353 check_preimage_claim(&nodes[3], &node_txn);
2355 check_closed_broadcast!(nodes[3], true);
2356 assert_eq!(nodes[2].node.list_channels().len(), 0);
2357 assert_eq!(nodes[3].node.list_channels().len(), 1);
2359 // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2360 // confusing us in the following tests.
2361 let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2363 // One pending HTLC to time out:
2364 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2365 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2368 let (close_chan_update_1, close_chan_update_2) = {
2369 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2370 let events = nodes[3].node.get_and_clear_pending_msg_events();
2371 assert_eq!(events.len(), 2);
2372 let close_chan_update_1 = match events[0] {
2373 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2376 _ => panic!("Unexpected event"),
2379 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2380 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2382 _ => panic!("Unexpected event"),
2384 check_added_monitors!(nodes[3], 1);
2386 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2388 let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2389 node_txn.retain(|tx| {
2390 if tx.input[0].previous_output.txid == node2_commitment_txid {
2396 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2398 // Claim the payment on nodes[4], giving it knowledge of the preimage
2399 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2401 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2402 let events = nodes[4].node.get_and_clear_pending_msg_events();
2403 assert_eq!(events.len(), 2);
2404 let close_chan_update_2 = match events[0] {
2405 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2408 _ => panic!("Unexpected event"),
2411 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2412 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2414 _ => panic!("Unexpected event"),
2416 check_added_monitors!(nodes[4], 1);
2417 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2419 mine_transaction(&nodes[4], &node_txn[0]);
2420 check_preimage_claim(&nodes[4], &node_txn);
2421 (close_chan_update_1, close_chan_update_2)
2423 nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2424 nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2425 assert_eq!(nodes[3].node.list_channels().len(), 0);
2426 assert_eq!(nodes[4].node.list_channels().len(), 0);
2428 nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2432 fn test_justice_tx() {
2433 // Test justice txn built on revoked HTLC-Success tx, against both sides
2434 let mut alice_config = UserConfig::default();
2435 alice_config.channel_options.announced_channel = true;
2436 alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2437 alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2438 let mut bob_config = UserConfig::default();
2439 bob_config.channel_options.announced_channel = true;
2440 bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2441 bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2442 let user_cfgs = [Some(alice_config), Some(bob_config)];
2443 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2444 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2445 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2446 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2447 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2448 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2449 // Create some new channels:
2450 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2452 // A pending HTLC which will be revoked:
2453 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2454 // Get the will-be-revoked local txn from nodes[0]
2455 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2456 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2457 assert_eq!(revoked_local_txn[0].input.len(), 1);
2458 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2459 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2460 assert_eq!(revoked_local_txn[1].input.len(), 1);
2461 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2462 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2463 // Revoke the old state
2464 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2467 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2469 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2470 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2471 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2473 check_spends!(node_txn[0], revoked_local_txn[0]);
2474 node_txn.swap_remove(0);
2475 node_txn.truncate(1);
2477 check_added_monitors!(nodes[1], 1);
2478 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2480 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2481 // Verify broadcast of revoked HTLC-timeout
2482 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2483 check_added_monitors!(nodes[0], 1);
2484 // Broadcast revoked HTLC-timeout on node 1
2485 mine_transaction(&nodes[1], &node_txn[1]);
2486 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2488 get_announce_close_broadcast_events(&nodes, 0, 1);
2490 assert_eq!(nodes[0].node.list_channels().len(), 0);
2491 assert_eq!(nodes[1].node.list_channels().len(), 0);
2493 // We test justice_tx build by A on B's revoked HTLC-Success tx
2494 // Create some new channels:
2495 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2497 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2501 // A pending HTLC which will be revoked:
2502 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2503 // Get the will-be-revoked local txn from B
2504 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2505 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2506 assert_eq!(revoked_local_txn[0].input.len(), 1);
2507 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2508 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2509 // Revoke the old state
2510 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2512 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2514 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2515 assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2516 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2518 check_spends!(node_txn[0], revoked_local_txn[0]);
2519 node_txn.swap_remove(0);
2521 check_added_monitors!(nodes[0], 1);
2522 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2524 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2525 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2526 check_added_monitors!(nodes[1], 1);
2527 mine_transaction(&nodes[0], &node_txn[1]);
2528 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2530 get_announce_close_broadcast_events(&nodes, 0, 1);
2531 assert_eq!(nodes[0].node.list_channels().len(), 0);
2532 assert_eq!(nodes[1].node.list_channels().len(), 0);
2536 fn revoked_output_claim() {
2537 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2538 // transaction is broadcast by its counterparty
2539 let chanmon_cfgs = create_chanmon_cfgs(2);
2540 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2541 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2542 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2543 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2544 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2545 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2546 assert_eq!(revoked_local_txn.len(), 1);
2547 // Only output is the full channel value back to nodes[0]:
2548 assert_eq!(revoked_local_txn[0].output.len(), 1);
2549 // Send a payment through, updating everyone's latest commitment txn
2550 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2552 // Inform nodes[1] that nodes[0] broadcast a stale tx
2553 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2554 check_added_monitors!(nodes[1], 1);
2555 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2556 assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2558 check_spends!(node_txn[0], revoked_local_txn[0]);
2559 check_spends!(node_txn[1], chan_1.3);
2561 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2562 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2563 get_announce_close_broadcast_events(&nodes, 0, 1);
2564 check_added_monitors!(nodes[0], 1)
2568 fn claim_htlc_outputs_shared_tx() {
2569 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2570 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2571 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2572 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2573 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2574 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2576 // Create some new channel:
2577 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2579 // Rebalance the network to generate htlc in the two directions
2580 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2581 // 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
2582 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2583 let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2585 // Get the will-be-revoked local txn from node[0]
2586 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2587 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2588 assert_eq!(revoked_local_txn[0].input.len(), 1);
2589 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2590 assert_eq!(revoked_local_txn[1].input.len(), 1);
2591 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2592 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2593 check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2595 //Revoke the old state
2596 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2599 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2600 check_added_monitors!(nodes[0], 1);
2601 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2602 check_added_monitors!(nodes[1], 1);
2603 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2604 expect_payment_failed!(nodes[1], payment_hash_2, true);
2606 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2607 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2609 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2610 check_spends!(node_txn[0], revoked_local_txn[0]);
2612 let mut witness_lens = BTreeSet::new();
2613 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2614 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2615 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2616 assert_eq!(witness_lens.len(), 3);
2617 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2618 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2619 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2621 // Next nodes[1] broadcasts its current local tx state:
2622 assert_eq!(node_txn[1].input.len(), 1);
2623 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2625 assert_eq!(node_txn[2].input.len(), 1);
2626 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2627 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2628 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2629 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2630 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2632 get_announce_close_broadcast_events(&nodes, 0, 1);
2633 assert_eq!(nodes[0].node.list_channels().len(), 0);
2634 assert_eq!(nodes[1].node.list_channels().len(), 0);
2638 fn claim_htlc_outputs_single_tx() {
2639 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2640 let mut chanmon_cfgs = create_chanmon_cfgs(2);
2641 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2642 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2643 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2644 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2646 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2648 // Rebalance the network to generate htlc in the two directions
2649 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2650 // 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
2651 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2652 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2653 let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2655 // Get the will-be-revoked local txn from node[0]
2656 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2658 //Revoke the old state
2659 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2662 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2663 check_added_monitors!(nodes[0], 1);
2664 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2665 check_added_monitors!(nodes[1], 1);
2666 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2668 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2669 expect_payment_failed!(nodes[1], payment_hash_2, true);
2671 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2672 assert_eq!(node_txn.len(), 9);
2673 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2674 // ChannelManager: local commmitment + local HTLC-timeout (2)
2675 // 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)
2676 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2678 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2679 assert_eq!(node_txn[0].input.len(), 1);
2680 check_spends!(node_txn[0], chan_1.3);
2681 assert_eq!(node_txn[1].input.len(), 1);
2682 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2683 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2684 check_spends!(node_txn[1], node_txn[0]);
2686 // Justice transactions are indices 1-2-4
2687 assert_eq!(node_txn[2].input.len(), 1);
2688 assert_eq!(node_txn[3].input.len(), 1);
2689 assert_eq!(node_txn[4].input.len(), 1);
2691 check_spends!(node_txn[2], revoked_local_txn[0]);
2692 check_spends!(node_txn[3], revoked_local_txn[0]);
2693 check_spends!(node_txn[4], revoked_local_txn[0]);
2695 let mut witness_lens = BTreeSet::new();
2696 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2697 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2698 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2699 assert_eq!(witness_lens.len(), 3);
2700 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2701 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2702 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2704 get_announce_close_broadcast_events(&nodes, 0, 1);
2705 assert_eq!(nodes[0].node.list_channels().len(), 0);
2706 assert_eq!(nodes[1].node.list_channels().len(), 0);
2710 fn test_htlc_on_chain_success() {
2711 // Test that in case of a unilateral close onchain, we detect the state of output and pass
2712 // the preimage backward accordingly. So here we test that ChannelManager is
2713 // broadcasting the right event to other nodes in payment path.
2714 // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2715 // A --------------------> B ----------------------> C (preimage)
2716 // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2717 // commitment transaction was broadcast.
2718 // Then, B should learn the preimage from said transactions, attempting to claim backwards
2720 // B should be able to claim via preimage if A then broadcasts its local tx.
2721 // Finally, when A sees B's latest local commitment transaction it should be able to claim
2722 // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2723 // PaymentSent event).
2725 let chanmon_cfgs = create_chanmon_cfgs(3);
2726 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2727 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2728 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2730 // Create some initial channels
2731 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2732 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2734 // Rebalance the network a bit by relaying one payment through all the channels...
2735 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2736 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2738 let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2739 let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2741 // Broadcast legit commitment tx from C on B's chain
2742 // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2743 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2744 assert_eq!(commitment_tx.len(), 1);
2745 check_spends!(commitment_tx[0], chan_2.3);
2746 nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2747 nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2748 check_added_monitors!(nodes[2], 2);
2749 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2750 assert!(updates.update_add_htlcs.is_empty());
2751 assert!(updates.update_fail_htlcs.is_empty());
2752 assert!(updates.update_fail_malformed_htlcs.is_empty());
2753 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2755 mine_transaction(&nodes[2], &commitment_tx[0]);
2756 check_closed_broadcast!(nodes[2], true);
2757 check_added_monitors!(nodes[2], 1);
2758 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)
2759 assert_eq!(node_txn.len(), 5);
2760 assert_eq!(node_txn[0], node_txn[3]);
2761 assert_eq!(node_txn[1], node_txn[4]);
2762 assert_eq!(node_txn[2], commitment_tx[0]);
2763 check_spends!(node_txn[0], commitment_tx[0]);
2764 check_spends!(node_txn[1], commitment_tx[0]);
2765 assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2766 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2767 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2768 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2769 assert_eq!(node_txn[0].lock_time, 0);
2770 assert_eq!(node_txn[1].lock_time, 0);
2772 // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2773 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2774 connect_block(&nodes[1], &Block { header, txdata: node_txn});
2776 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2777 assert_eq!(added_monitors.len(), 1);
2778 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2779 added_monitors.clear();
2781 let events = nodes[1].node.get_and_clear_pending_msg_events();
2783 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2784 assert_eq!(added_monitors.len(), 2);
2785 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2786 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2787 added_monitors.clear();
2789 assert_eq!(events.len(), 3);
2791 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2792 _ => panic!("Unexpected event"),
2795 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2796 _ => panic!("Unexpected event"),
2800 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, .. } } => {
2801 assert!(update_add_htlcs.is_empty());
2802 assert!(update_fail_htlcs.is_empty());
2803 assert_eq!(update_fulfill_htlcs.len(), 1);
2804 assert!(update_fail_malformed_htlcs.is_empty());
2805 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2807 _ => panic!("Unexpected event"),
2809 macro_rules! check_tx_local_broadcast {
2810 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2811 let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2812 assert_eq!(node_txn.len(), 5);
2813 // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2814 // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2815 check_spends!(node_txn[0], $commitment_tx);
2816 check_spends!(node_txn[1], $commitment_tx);
2817 assert_ne!(node_txn[0].lock_time, 0);
2818 assert_ne!(node_txn[1].lock_time, 0);
2820 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2821 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2822 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2823 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2825 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2826 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2827 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2828 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2830 check_spends!(node_txn[2], $chan_tx);
2831 check_spends!(node_txn[3], node_txn[2]);
2832 check_spends!(node_txn[4], node_txn[2]);
2833 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2834 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2835 assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2836 assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2837 assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2838 assert_ne!(node_txn[3].lock_time, 0);
2839 assert_ne!(node_txn[4].lock_time, 0);
2843 // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2844 // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2845 // timeout-claim of the output that nodes[2] just claimed via success.
2846 check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2848 // Broadcast legit commitment tx from A on B's chain
2849 // Broadcast preimage tx by B on offered output from A commitment tx on A's chain
2850 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2851 check_spends!(commitment_tx[0], chan_1.3);
2852 mine_transaction(&nodes[1], &commitment_tx[0]);
2853 check_closed_broadcast!(nodes[1], true);
2854 check_added_monitors!(nodes[1], 1);
2855 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2856 assert_eq!(node_txn.len(), 4);
2857 check_spends!(node_txn[0], commitment_tx[0]);
2858 assert_eq!(node_txn[0].input.len(), 2);
2859 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2860 assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2861 assert_eq!(node_txn[0].lock_time, 0);
2862 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2863 check_spends!(node_txn[1], chan_1.3);
2864 assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2865 check_spends!(node_txn[2], node_txn[1]);
2866 check_spends!(node_txn[3], node_txn[1]);
2867 // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2868 // we already checked the same situation with A.
2870 // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2871 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2872 connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] });
2873 check_closed_broadcast!(nodes[0], true);
2874 check_added_monitors!(nodes[0], 1);
2875 let events = nodes[0].node.get_and_clear_pending_events();
2876 assert_eq!(events.len(), 2);
2877 let mut first_claimed = false;
2878 for event in events {
2880 Event::PaymentSent { payment_preimage } => {
2881 if payment_preimage == our_payment_preimage {
2882 assert!(!first_claimed);
2883 first_claimed = true;
2885 assert_eq!(payment_preimage, our_payment_preimage_2);
2888 _ => panic!("Unexpected event"),
2891 check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2894 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2895 // Test that in case of a unilateral close onchain, we detect the state of output and
2896 // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2897 // broadcasting the right event to other nodes in payment path.
2898 // A ------------------> B ----------------------> C (timeout)
2899 // B's commitment tx C's commitment tx
2901 // B's HTLC timeout tx B's timeout tx
2903 let chanmon_cfgs = create_chanmon_cfgs(3);
2904 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2905 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2906 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2907 *nodes[0].connect_style.borrow_mut() = connect_style;
2908 *nodes[1].connect_style.borrow_mut() = connect_style;
2909 *nodes[2].connect_style.borrow_mut() = connect_style;
2911 // Create some intial channels
2912 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2913 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2915 // Rebalance the network a bit by relaying one payment thorugh all the channels...
2916 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2917 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2919 let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2921 // Broadcast legit commitment tx from C on B's chain
2922 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2923 check_spends!(commitment_tx[0], chan_2.3);
2924 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2925 check_added_monitors!(nodes[2], 0);
2926 expect_pending_htlcs_forwardable!(nodes[2]);
2927 check_added_monitors!(nodes[2], 1);
2929 let events = nodes[2].node.get_and_clear_pending_msg_events();
2930 assert_eq!(events.len(), 1);
2932 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, .. } } => {
2933 assert!(update_add_htlcs.is_empty());
2934 assert!(!update_fail_htlcs.is_empty());
2935 assert!(update_fulfill_htlcs.is_empty());
2936 assert!(update_fail_malformed_htlcs.is_empty());
2937 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2939 _ => panic!("Unexpected event"),
2941 mine_transaction(&nodes[2], &commitment_tx[0]);
2942 check_closed_broadcast!(nodes[2], true);
2943 check_added_monitors!(nodes[2], 1);
2944 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2945 assert_eq!(node_txn.len(), 1);
2946 check_spends!(node_txn[0], chan_2.3);
2947 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2949 // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2950 // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2951 connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2952 mine_transaction(&nodes[1], &commitment_tx[0]);
2955 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2956 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2957 assert_eq!(node_txn[0], node_txn[3]);
2958 assert_eq!(node_txn[1], node_txn[4]);
2960 check_spends!(node_txn[2], commitment_tx[0]);
2961 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2963 check_spends!(node_txn[0], chan_2.3);
2964 check_spends!(node_txn[1], node_txn[0]);
2965 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2966 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2968 timeout_tx = node_txn[2].clone();
2972 mine_transaction(&nodes[1], &timeout_tx);
2973 check_added_monitors!(nodes[1], 1);
2974 check_closed_broadcast!(nodes[1], true);
2976 // B will rebroadcast a fee-bumped timeout transaction here.
2977 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2978 assert_eq!(node_txn.len(), 1);
2979 check_spends!(node_txn[0], commitment_tx[0]);
2982 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2984 // B will rebroadcast its own holder commitment transaction here...just because
2985 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2986 assert_eq!(node_txn.len(), 1);
2987 check_spends!(node_txn[0], chan_2.3);
2990 expect_pending_htlcs_forwardable!(nodes[1]);
2991 check_added_monitors!(nodes[1], 1);
2992 let events = nodes[1].node.get_and_clear_pending_msg_events();
2993 assert_eq!(events.len(), 1);
2995 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, .. } } => {
2996 assert!(update_add_htlcs.is_empty());
2997 assert!(!update_fail_htlcs.is_empty());
2998 assert!(update_fulfill_htlcs.is_empty());
2999 assert!(update_fail_malformed_htlcs.is_empty());
3000 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3002 _ => panic!("Unexpected event"),
3005 // Broadcast legit commitment tx from B on A's chain
3006 let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3007 check_spends!(commitment_tx[0], chan_1.3);
3009 mine_transaction(&nodes[0], &commitment_tx[0]);
3011 check_closed_broadcast!(nodes[0], true);
3012 check_added_monitors!(nodes[0], 1);
3013 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3014 assert_eq!(node_txn.len(), 3);
3015 check_spends!(node_txn[0], commitment_tx[0]);
3016 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3017 check_spends!(node_txn[1], chan_1.3);
3018 check_spends!(node_txn[2], node_txn[1]);
3019 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3020 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3024 fn test_htlc_on_chain_timeout() {
3025 do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3026 do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3027 do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3031 fn test_simple_commitment_revoked_fail_backward() {
3032 // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3033 // and fail backward accordingly.
3035 let chanmon_cfgs = create_chanmon_cfgs(3);
3036 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3037 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3038 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3040 // Create some initial channels
3041 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3042 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3044 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3045 // Get the will-be-revoked local txn from nodes[2]
3046 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3047 // Revoke the old state
3048 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3050 let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3052 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3053 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3054 check_added_monitors!(nodes[1], 1);
3055 check_closed_broadcast!(nodes[1], true);
3057 expect_pending_htlcs_forwardable!(nodes[1]);
3058 check_added_monitors!(nodes[1], 1);
3059 let events = nodes[1].node.get_and_clear_pending_msg_events();
3060 assert_eq!(events.len(), 1);
3062 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, .. } } => {
3063 assert!(update_add_htlcs.is_empty());
3064 assert_eq!(update_fail_htlcs.len(), 1);
3065 assert!(update_fulfill_htlcs.is_empty());
3066 assert!(update_fail_malformed_htlcs.is_empty());
3067 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3069 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3070 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3072 let events = nodes[0].node.get_and_clear_pending_msg_events();
3073 assert_eq!(events.len(), 1);
3075 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3076 _ => panic!("Unexpected event"),
3078 expect_payment_failed!(nodes[0], payment_hash, false);
3080 _ => panic!("Unexpected event"),
3084 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3085 // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3086 // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3087 // commitment transaction anymore.
3088 // To do this, we have the peer which will broadcast a revoked commitment transaction send
3089 // a number of update_fail/commitment_signed updates without ever sending the RAA in
3090 // response to our commitment_signed. This is somewhat misbehavior-y, though not
3091 // technically disallowed and we should probably handle it reasonably.
3092 // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3093 // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3095 // * Once we move it out of our holding cell/add it, we will immediately include it in a
3096 // commitment_signed (implying it will be in the latest remote commitment transaction).
3097 // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3098 // and once they revoke the previous commitment transaction (allowing us to send a new
3099 // commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3100 let chanmon_cfgs = create_chanmon_cfgs(3);
3101 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3102 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3103 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3105 // Create some initial channels
3106 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3107 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3109 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3110 // Get the will-be-revoked local txn from nodes[2]
3111 let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3112 assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3113 // Revoke the old state
3114 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3116 let value = if use_dust {
3117 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3118 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3119 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3122 let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3123 let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3124 let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3126 assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3127 expect_pending_htlcs_forwardable!(nodes[2]);
3128 check_added_monitors!(nodes[2], 1);
3129 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3130 assert!(updates.update_add_htlcs.is_empty());
3131 assert!(updates.update_fulfill_htlcs.is_empty());
3132 assert!(updates.update_fail_malformed_htlcs.is_empty());
3133 assert_eq!(updates.update_fail_htlcs.len(), 1);
3134 assert!(updates.update_fee.is_none());
3135 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3136 let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3137 // Drop the last RAA from 3 -> 2
3139 assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3140 expect_pending_htlcs_forwardable!(nodes[2]);
3141 check_added_monitors!(nodes[2], 1);
3142 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3143 assert!(updates.update_add_htlcs.is_empty());
3144 assert!(updates.update_fulfill_htlcs.is_empty());
3145 assert!(updates.update_fail_malformed_htlcs.is_empty());
3146 assert_eq!(updates.update_fail_htlcs.len(), 1);
3147 assert!(updates.update_fee.is_none());
3148 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3149 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3150 check_added_monitors!(nodes[1], 1);
3151 // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3152 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3153 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3154 check_added_monitors!(nodes[2], 1);
3156 assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3157 expect_pending_htlcs_forwardable!(nodes[2]);
3158 check_added_monitors!(nodes[2], 1);
3159 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3160 assert!(updates.update_add_htlcs.is_empty());
3161 assert!(updates.update_fulfill_htlcs.is_empty());
3162 assert!(updates.update_fail_malformed_htlcs.is_empty());
3163 assert_eq!(updates.update_fail_htlcs.len(), 1);
3164 assert!(updates.update_fee.is_none());
3165 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3166 // At this point first_payment_hash has dropped out of the latest two commitment
3167 // transactions that nodes[1] is tracking...
3168 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3169 check_added_monitors!(nodes[1], 1);
3170 // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3171 let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3172 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3173 check_added_monitors!(nodes[2], 1);
3175 // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3176 // on nodes[2]'s RAA.
3177 let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3178 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3179 let logger = test_utils::TestLogger::new();
3180 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3181 nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3182 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3183 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3184 check_added_monitors!(nodes[1], 0);
3187 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3188 // One monitor for the new revocation preimage, no second on as we won't generate a new
3189 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3190 check_added_monitors!(nodes[1], 1);
3191 let events = nodes[1].node.get_and_clear_pending_events();
3192 assert_eq!(events.len(), 1);
3194 Event::PendingHTLCsForwardable { .. } => { },
3195 _ => panic!("Unexpected event"),
3197 // Deliberately don't process the pending fail-back so they all fail back at once after
3198 // block connection just like the !deliver_bs_raa case
3201 let mut failed_htlcs = HashSet::new();
3202 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3204 mine_transaction(&nodes[1], &revoked_local_txn[0]);
3205 check_added_monitors!(nodes[1], 1);
3206 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3208 let events = nodes[1].node.get_and_clear_pending_events();
3209 assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3211 Event::PaymentFailed { ref payment_hash, .. } => {
3212 assert_eq!(*payment_hash, fourth_payment_hash);
3214 _ => panic!("Unexpected event"),
3216 if !deliver_bs_raa {
3218 Event::PendingHTLCsForwardable { .. } => { },
3219 _ => panic!("Unexpected event"),
3222 nodes[1].node.process_pending_htlc_forwards();
3223 check_added_monitors!(nodes[1], 1);
3225 let events = nodes[1].node.get_and_clear_pending_msg_events();
3226 assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3227 match events[if deliver_bs_raa { 1 } else { 0 }] {
3228 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3229 _ => panic!("Unexpected event"),
3231 match events[if deliver_bs_raa { 2 } else { 1 }] {
3232 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3233 assert_eq!(channel_id, chan_2.2);
3234 assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3236 _ => panic!("Unexpected event"),
3240 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, .. } } => {
3241 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3242 assert_eq!(update_add_htlcs.len(), 1);
3243 assert!(update_fulfill_htlcs.is_empty());
3244 assert!(update_fail_htlcs.is_empty());
3245 assert!(update_fail_malformed_htlcs.is_empty());
3247 _ => panic!("Unexpected event"),
3250 match events[if deliver_bs_raa { 3 } else { 2 }] {
3251 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, .. } } => {
3252 assert!(update_add_htlcs.is_empty());
3253 assert_eq!(update_fail_htlcs.len(), 3);
3254 assert!(update_fulfill_htlcs.is_empty());
3255 assert!(update_fail_malformed_htlcs.is_empty());
3256 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3258 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3259 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3260 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3262 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3264 let events = nodes[0].node.get_and_clear_pending_msg_events();
3265 // If we delivered B's RAA we got an unknown preimage error, not something
3266 // that we should update our routing table for.
3267 assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3268 for event in events {
3270 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3271 _ => panic!("Unexpected event"),
3274 let events = nodes[0].node.get_and_clear_pending_events();
3275 assert_eq!(events.len(), 3);
3277 Event::PaymentFailed { ref payment_hash, .. } => {
3278 assert!(failed_htlcs.insert(payment_hash.0));
3280 _ => panic!("Unexpected event"),
3283 Event::PaymentFailed { ref payment_hash, .. } => {
3284 assert!(failed_htlcs.insert(payment_hash.0));
3286 _ => panic!("Unexpected event"),
3289 Event::PaymentFailed { ref payment_hash, .. } => {
3290 assert!(failed_htlcs.insert(payment_hash.0));
3292 _ => panic!("Unexpected event"),
3295 _ => panic!("Unexpected event"),
3298 assert!(failed_htlcs.contains(&first_payment_hash.0));
3299 assert!(failed_htlcs.contains(&second_payment_hash.0));
3300 assert!(failed_htlcs.contains(&third_payment_hash.0));
3304 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3305 do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3306 do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3307 do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3308 do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3312 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3313 do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3314 do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3315 do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3316 do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3320 fn fail_backward_pending_htlc_upon_channel_failure() {
3321 let chanmon_cfgs = create_chanmon_cfgs(2);
3322 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3323 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3324 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3325 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3326 let logger = test_utils::TestLogger::new();
3328 // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3330 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3331 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3332 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3333 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3334 check_added_monitors!(nodes[0], 1);
3336 let payment_event = {
3337 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3338 assert_eq!(events.len(), 1);
3339 SendEvent::from_event(events.remove(0))
3341 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3342 assert_eq!(payment_event.msgs.len(), 1);
3345 // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3346 let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3348 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3349 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3350 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3351 check_added_monitors!(nodes[0], 0);
3353 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3356 // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3358 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3360 let secp_ctx = Secp256k1::new();
3361 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3362 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3363 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3364 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3365 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3366 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3367 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3369 // Send a 0-msat update_add_htlc to fail the channel.
3370 let update_add_htlc = msgs::UpdateAddHTLC {
3376 onion_routing_packet,
3378 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3381 // Check that Alice fails backward the pending HTLC from the second payment.
3382 expect_payment_failed!(nodes[0], failed_payment_hash, true);
3383 check_closed_broadcast!(nodes[0], true);
3384 check_added_monitors!(nodes[0], 1);
3388 fn test_htlc_ignore_latest_remote_commitment() {
3389 // Test that HTLC transactions spending the latest remote commitment transaction are simply
3390 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3391 let chanmon_cfgs = create_chanmon_cfgs(2);
3392 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3393 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3394 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3395 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3397 route_payment(&nodes[0], &[&nodes[1]], 10000000);
3398 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3399 check_closed_broadcast!(nodes[0], true);
3400 check_added_monitors!(nodes[0], 1);
3402 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3403 assert_eq!(node_txn.len(), 2);
3405 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3406 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3407 check_closed_broadcast!(nodes[1], true);
3408 check_added_monitors!(nodes[1], 1);
3410 // Duplicate the connect_block call since this may happen due to other listeners
3411 // registering new transactions
3412 header.prev_blockhash = header.block_hash();
3413 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3417 fn test_force_close_fail_back() {
3418 // Check which HTLCs are failed-backwards on channel force-closure
3419 let chanmon_cfgs = create_chanmon_cfgs(3);
3420 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3421 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3422 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3423 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3424 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3425 let logger = test_utils::TestLogger::new();
3427 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3429 let mut payment_event = {
3430 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3431 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3432 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3433 check_added_monitors!(nodes[0], 1);
3435 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3436 assert_eq!(events.len(), 1);
3437 SendEvent::from_event(events.remove(0))
3440 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3441 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3443 expect_pending_htlcs_forwardable!(nodes[1]);
3445 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3446 assert_eq!(events_2.len(), 1);
3447 payment_event = SendEvent::from_event(events_2.remove(0));
3448 assert_eq!(payment_event.msgs.len(), 1);
3450 check_added_monitors!(nodes[1], 1);
3451 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3452 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3453 check_added_monitors!(nodes[2], 1);
3454 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3456 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3457 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3458 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3460 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3461 check_closed_broadcast!(nodes[2], true);
3462 check_added_monitors!(nodes[2], 1);
3464 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3465 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3466 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3467 // back to nodes[1] upon timeout otherwise.
3468 assert_eq!(node_txn.len(), 1);
3472 mine_transaction(&nodes[1], &tx);
3474 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3475 check_closed_broadcast!(nodes[1], true);
3476 check_added_monitors!(nodes[1], 1);
3478 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3480 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3481 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3482 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3484 mine_transaction(&nodes[2], &tx);
3485 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3486 assert_eq!(node_txn.len(), 1);
3487 assert_eq!(node_txn[0].input.len(), 1);
3488 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3489 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3490 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3492 check_spends!(node_txn[0], tx);
3496 fn test_simple_peer_disconnect() {
3497 // Test that we can reconnect when there are no lost messages
3498 let chanmon_cfgs = create_chanmon_cfgs(3);
3499 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3500 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3501 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3502 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3503 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3505 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3506 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3507 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3509 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3510 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3511 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3512 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3514 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3515 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3516 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3518 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3519 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3520 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3521 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3523 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3524 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3526 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3527 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3529 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3531 let events = nodes[0].node.get_and_clear_pending_events();
3532 assert_eq!(events.len(), 2);
3534 Event::PaymentSent { payment_preimage } => {
3535 assert_eq!(payment_preimage, payment_preimage_3);
3537 _ => panic!("Unexpected event"),
3540 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3541 assert_eq!(payment_hash, payment_hash_5);
3542 assert!(rejected_by_dest);
3544 _ => panic!("Unexpected event"),
3548 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3549 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3552 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3553 // Test that we can reconnect when in-flight HTLC updates get dropped
3554 let chanmon_cfgs = create_chanmon_cfgs(2);
3555 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3556 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3557 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3558 if messages_delivered == 0 {
3559 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3560 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3562 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3565 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3567 let logger = test_utils::TestLogger::new();
3568 let payment_event = {
3569 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3570 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3571 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3572 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3573 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3574 check_added_monitors!(nodes[0], 1);
3576 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3577 assert_eq!(events.len(), 1);
3578 SendEvent::from_event(events.remove(0))
3580 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3582 if messages_delivered < 2 {
3583 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3585 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3586 if messages_delivered >= 3 {
3587 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3588 check_added_monitors!(nodes[1], 1);
3589 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3591 if messages_delivered >= 4 {
3592 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3593 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3594 check_added_monitors!(nodes[0], 1);
3596 if messages_delivered >= 5 {
3597 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3598 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3599 // No commitment_signed so get_event_msg's assert(len == 1) passes
3600 check_added_monitors!(nodes[0], 1);
3602 if messages_delivered >= 6 {
3603 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3604 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3605 check_added_monitors!(nodes[1], 1);
3612 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3613 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3614 if messages_delivered < 3 {
3615 // Even if the funding_locked messages get exchanged, as long as nothing further was
3616 // received on either side, both sides will need to resend them.
3617 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3618 } else if messages_delivered == 3 {
3619 // nodes[0] still wants its RAA + commitment_signed
3620 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3621 } else if messages_delivered == 4 {
3622 // nodes[0] still wants its commitment_signed
3623 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3624 } else if messages_delivered == 5 {
3625 // nodes[1] still wants its final RAA
3626 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3627 } else if messages_delivered == 6 {
3628 // Everything was delivered...
3629 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3632 let events_1 = nodes[1].node.get_and_clear_pending_events();
3633 assert_eq!(events_1.len(), 1);
3635 Event::PendingHTLCsForwardable { .. } => { },
3636 _ => panic!("Unexpected event"),
3639 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3640 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3641 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3643 nodes[1].node.process_pending_htlc_forwards();
3645 let events_2 = nodes[1].node.get_and_clear_pending_events();
3646 assert_eq!(events_2.len(), 1);
3648 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3649 assert_eq!(payment_hash_1, *payment_hash);
3650 assert_eq!(*payment_secret, None);
3651 assert_eq!(amt, 1000000);
3653 _ => panic!("Unexpected event"),
3656 nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3657 check_added_monitors!(nodes[1], 1);
3659 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3660 assert_eq!(events_3.len(), 1);
3661 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3662 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3663 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3664 assert!(updates.update_add_htlcs.is_empty());
3665 assert!(updates.update_fail_htlcs.is_empty());
3666 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3667 assert!(updates.update_fail_malformed_htlcs.is_empty());
3668 assert!(updates.update_fee.is_none());
3669 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3671 _ => panic!("Unexpected event"),
3674 if messages_delivered >= 1 {
3675 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3677 let events_4 = nodes[0].node.get_and_clear_pending_events();
3678 assert_eq!(events_4.len(), 1);
3680 Event::PaymentSent { ref payment_preimage } => {
3681 assert_eq!(payment_preimage_1, *payment_preimage);
3683 _ => panic!("Unexpected event"),
3686 if messages_delivered >= 2 {
3687 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3688 check_added_monitors!(nodes[0], 1);
3689 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3691 if messages_delivered >= 3 {
3692 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3693 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3694 check_added_monitors!(nodes[1], 1);
3696 if messages_delivered >= 4 {
3697 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3698 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3699 // No commitment_signed so get_event_msg's assert(len == 1) passes
3700 check_added_monitors!(nodes[1], 1);
3702 if messages_delivered >= 5 {
3703 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3704 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3705 check_added_monitors!(nodes[0], 1);
3712 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3713 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3714 if messages_delivered < 2 {
3715 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3716 //TODO: Deduplicate PaymentSent events, then enable this if:
3717 //if messages_delivered < 1 {
3718 let events_4 = nodes[0].node.get_and_clear_pending_events();
3719 assert_eq!(events_4.len(), 1);
3721 Event::PaymentSent { ref payment_preimage } => {
3722 assert_eq!(payment_preimage_1, *payment_preimage);
3724 _ => panic!("Unexpected event"),
3727 } else if messages_delivered == 2 {
3728 // nodes[0] still wants its RAA + commitment_signed
3729 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3730 } else if messages_delivered == 3 {
3731 // nodes[0] still wants its commitment_signed
3732 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3733 } else if messages_delivered == 4 {
3734 // nodes[1] still wants its final RAA
3735 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3736 } else if messages_delivered == 5 {
3737 // Everything was delivered...
3738 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3741 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3742 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3743 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3745 // Channel should still work fine...
3746 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3747 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3748 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3749 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3750 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3751 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3755 fn test_drop_messages_peer_disconnect_a() {
3756 do_test_drop_messages_peer_disconnect(0);
3757 do_test_drop_messages_peer_disconnect(1);
3758 do_test_drop_messages_peer_disconnect(2);
3759 do_test_drop_messages_peer_disconnect(3);
3763 fn test_drop_messages_peer_disconnect_b() {
3764 do_test_drop_messages_peer_disconnect(4);
3765 do_test_drop_messages_peer_disconnect(5);
3766 do_test_drop_messages_peer_disconnect(6);
3770 fn test_funding_peer_disconnect() {
3771 // Test that we can lock in our funding tx while disconnected
3772 let chanmon_cfgs = create_chanmon_cfgs(2);
3773 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3774 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3775 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3776 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3778 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3779 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3781 confirm_transaction(&nodes[0], &tx);
3782 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3783 assert_eq!(events_1.len(), 1);
3785 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3786 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3788 _ => panic!("Unexpected event"),
3791 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3793 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3794 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3796 confirm_transaction(&nodes[1], &tx);
3797 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3798 assert_eq!(events_2.len(), 2);
3799 let funding_locked = match events_2[0] {
3800 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3801 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3804 _ => panic!("Unexpected event"),
3806 let bs_announcement_sigs = match events_2[1] {
3807 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3808 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3811 _ => panic!("Unexpected event"),
3814 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3816 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3817 nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3818 let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3819 assert_eq!(events_3.len(), 2);
3820 let as_announcement_sigs = match events_3[0] {
3821 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3822 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3825 _ => panic!("Unexpected event"),
3827 let (as_announcement, as_update) = match events_3[1] {
3828 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3829 (msg.clone(), update_msg.clone())
3831 _ => panic!("Unexpected event"),
3834 nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3835 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3836 assert_eq!(events_4.len(), 1);
3837 let (_, bs_update) = match events_4[0] {
3838 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3839 (msg.clone(), update_msg.clone())
3841 _ => panic!("Unexpected event"),
3844 nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3845 nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3846 nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3848 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3849 let logger = test_utils::TestLogger::new();
3850 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3851 let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3852 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3856 fn test_drop_messages_peer_disconnect_dual_htlc() {
3857 // Test that we can handle reconnecting when both sides of a channel have pending
3858 // commitment_updates when we disconnect.
3859 let chanmon_cfgs = create_chanmon_cfgs(2);
3860 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3861 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3862 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3863 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3864 let logger = test_utils::TestLogger::new();
3866 let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3868 // Now try to send a second payment which will fail to send
3869 let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3870 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3871 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3872 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3873 check_added_monitors!(nodes[0], 1);
3875 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3876 assert_eq!(events_1.len(), 1);
3878 MessageSendEvent::UpdateHTLCs { .. } => {},
3879 _ => panic!("Unexpected event"),
3882 assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3883 check_added_monitors!(nodes[1], 1);
3885 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3886 assert_eq!(events_2.len(), 1);
3888 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 } } => {
3889 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3890 assert!(update_add_htlcs.is_empty());
3891 assert_eq!(update_fulfill_htlcs.len(), 1);
3892 assert!(update_fail_htlcs.is_empty());
3893 assert!(update_fail_malformed_htlcs.is_empty());
3894 assert!(update_fee.is_none());
3896 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3897 let events_3 = nodes[0].node.get_and_clear_pending_events();
3898 assert_eq!(events_3.len(), 1);
3900 Event::PaymentSent { ref payment_preimage } => {
3901 assert_eq!(*payment_preimage, payment_preimage_1);
3903 _ => panic!("Unexpected event"),
3906 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3907 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3908 // No commitment_signed so get_event_msg's assert(len == 1) passes
3909 check_added_monitors!(nodes[0], 1);
3911 _ => panic!("Unexpected event"),
3914 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3915 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3917 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3918 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3919 assert_eq!(reestablish_1.len(), 1);
3920 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3921 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3922 assert_eq!(reestablish_2.len(), 1);
3924 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3925 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3926 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3927 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3929 assert!(as_resp.0.is_none());
3930 assert!(bs_resp.0.is_none());
3932 assert!(bs_resp.1.is_none());
3933 assert!(bs_resp.2.is_none());
3935 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3937 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3938 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3939 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3940 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3941 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3942 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3943 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3944 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3945 // No commitment_signed so get_event_msg's assert(len == 1) passes
3946 check_added_monitors!(nodes[1], 1);
3948 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3949 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3950 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3951 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3952 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3953 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3954 assert!(bs_second_commitment_signed.update_fee.is_none());
3955 check_added_monitors!(nodes[1], 1);
3957 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3958 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3959 assert!(as_commitment_signed.update_add_htlcs.is_empty());
3960 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3961 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3962 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3963 assert!(as_commitment_signed.update_fee.is_none());
3964 check_added_monitors!(nodes[0], 1);
3966 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3967 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3968 // No commitment_signed so get_event_msg's assert(len == 1) passes
3969 check_added_monitors!(nodes[0], 1);
3971 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3972 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3973 // No commitment_signed so get_event_msg's assert(len == 1) passes
3974 check_added_monitors!(nodes[1], 1);
3976 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3977 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3978 check_added_monitors!(nodes[1], 1);
3980 expect_pending_htlcs_forwardable!(nodes[1]);
3982 let events_5 = nodes[1].node.get_and_clear_pending_events();
3983 assert_eq!(events_5.len(), 1);
3985 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3986 assert_eq!(payment_hash_2, *payment_hash);
3987 assert_eq!(*payment_secret, None);
3989 _ => panic!("Unexpected event"),
3992 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3993 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3994 check_added_monitors!(nodes[0], 1);
3996 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3999 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4000 // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4001 // to avoid our counterparty failing the channel.
4002 let chanmon_cfgs = create_chanmon_cfgs(2);
4003 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4004 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4005 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4007 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4008 let logger = test_utils::TestLogger::new();
4010 let our_payment_hash = if send_partial_mpp {
4011 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4012 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4013 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4014 // Use the utility function send_payment_along_path to send the payment with MPP data which
4015 // indicates there are more HTLCs coming.
4016 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.
4017 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4018 check_added_monitors!(nodes[0], 1);
4019 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4020 assert_eq!(events.len(), 1);
4021 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4022 // hop should *not* yet generate any PaymentReceived event(s).
4023 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4026 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4029 let mut block = Block {
4030 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4033 connect_block(&nodes[0], &block);
4034 connect_block(&nodes[1], &block);
4035 for _ in CHAN_CONFIRM_DEPTH + 2 ..TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4036 block.header.prev_blockhash = block.block_hash();
4037 connect_block(&nodes[0], &block);
4038 connect_block(&nodes[1], &block);
4041 expect_pending_htlcs_forwardable!(nodes[1]);
4043 check_added_monitors!(nodes[1], 1);
4044 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4045 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4046 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4047 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4048 assert!(htlc_timeout_updates.update_fee.is_none());
4050 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4051 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4052 // 100_000 msat as u64, followed by a height of TEST_FINAL_CLTV + 2 as u32
4053 let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4054 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(TEST_FINAL_CLTV + 2));
4055 expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4059 fn test_htlc_timeout() {
4060 do_test_htlc_timeout(true);
4061 do_test_htlc_timeout(false);
4064 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4065 // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4066 let chanmon_cfgs = create_chanmon_cfgs(3);
4067 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4068 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4069 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4070 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4071 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4073 // Make sure all nodes are at the same starting height
4074 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4075 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4076 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4078 let logger = test_utils::TestLogger::new();
4080 // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4081 let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4083 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4084 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4085 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4087 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4088 check_added_monitors!(nodes[1], 1);
4090 // Now attempt to route a second payment, which should be placed in the holding cell
4091 let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4093 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4094 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4095 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4096 check_added_monitors!(nodes[0], 1);
4097 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4098 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4099 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4100 expect_pending_htlcs_forwardable!(nodes[1]);
4101 check_added_monitors!(nodes[1], 0);
4103 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4104 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4105 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4106 check_added_monitors!(nodes[1], 0);
4109 connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4110 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4111 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4112 connect_blocks(&nodes[1], 1);
4115 expect_pending_htlcs_forwardable!(nodes[1]);
4116 check_added_monitors!(nodes[1], 1);
4117 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4118 assert_eq!(fail_commit.len(), 1);
4119 match fail_commit[0] {
4120 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4121 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4122 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4124 _ => unreachable!(),
4126 expect_payment_failed!(nodes[0], second_payment_hash, false);
4127 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4129 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4130 _ => panic!("Unexpected event"),
4133 panic!("Unexpected event");
4136 expect_payment_failed!(nodes[1], second_payment_hash, true);
4141 fn test_holding_cell_htlc_add_timeouts() {
4142 do_test_holding_cell_htlc_add_timeouts(false);
4143 do_test_holding_cell_htlc_add_timeouts(true);
4147 fn test_invalid_channel_announcement() {
4148 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4149 let secp_ctx = Secp256k1::new();
4150 let chanmon_cfgs = create_chanmon_cfgs(2);
4151 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4152 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4153 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4155 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4157 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4158 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4159 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4160 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4162 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 } );
4164 let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4165 let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4167 let as_network_key = nodes[0].node.get_our_node_id();
4168 let bs_network_key = nodes[1].node.get_our_node_id();
4170 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4172 let mut chan_announcement;
4174 macro_rules! dummy_unsigned_msg {
4176 msgs::UnsignedChannelAnnouncement {
4177 features: ChannelFeatures::known(),
4178 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4179 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4180 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4181 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4182 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4183 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4184 excess_data: Vec::new(),
4189 macro_rules! sign_msg {
4190 ($unsigned_msg: expr) => {
4191 let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4192 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4193 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4194 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4195 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4196 chan_announcement = msgs::ChannelAnnouncement {
4197 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4198 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4199 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4200 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4201 contents: $unsigned_msg
4206 let unsigned_msg = dummy_unsigned_msg!();
4207 sign_msg!(unsigned_msg);
4208 assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4209 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 } );
4211 // Configured with Network::Testnet
4212 let mut unsigned_msg = dummy_unsigned_msg!();
4213 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4214 sign_msg!(unsigned_msg);
4215 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4217 let mut unsigned_msg = dummy_unsigned_msg!();
4218 unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4219 sign_msg!(unsigned_msg);
4220 assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4224 fn test_no_txn_manager_serialize_deserialize() {
4225 let chanmon_cfgs = create_chanmon_cfgs(2);
4226 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4227 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4228 let logger: test_utils::TestLogger;
4229 let fee_estimator: test_utils::TestFeeEstimator;
4230 let persister: test_utils::TestPersister;
4231 let new_chain_monitor: test_utils::TestChainMonitor;
4232 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4233 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4235 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4237 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4239 let nodes_0_serialized = nodes[0].node.encode();
4240 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4241 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4243 logger = test_utils::TestLogger::new();
4244 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4245 persister = test_utils::TestPersister::new();
4246 let keys_manager = &chanmon_cfgs[0].keys_manager;
4247 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4248 nodes[0].chain_monitor = &new_chain_monitor;
4249 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4250 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4251 &mut chan_0_monitor_read, keys_manager).unwrap();
4252 assert!(chan_0_monitor_read.is_empty());
4254 let mut nodes_0_read = &nodes_0_serialized[..];
4255 let config = UserConfig::default();
4256 let (_, nodes_0_deserialized_tmp) = {
4257 let mut channel_monitors = HashMap::new();
4258 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4259 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4260 default_config: config,
4262 fee_estimator: &fee_estimator,
4263 chain_monitor: nodes[0].chain_monitor,
4264 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4269 nodes_0_deserialized = nodes_0_deserialized_tmp;
4270 assert!(nodes_0_read.is_empty());
4272 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4273 nodes[0].node = &nodes_0_deserialized;
4274 assert_eq!(nodes[0].node.list_channels().len(), 1);
4275 check_added_monitors!(nodes[0], 1);
4277 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4278 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4279 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4280 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4282 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4283 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4284 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4285 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4287 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4288 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4289 for node in nodes.iter() {
4290 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4291 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4292 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4295 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4299 fn test_manager_serialize_deserialize_events() {
4300 // This test makes sure the events field in ChannelManager survives de/serialization
4301 let chanmon_cfgs = create_chanmon_cfgs(2);
4302 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4303 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4304 let fee_estimator: test_utils::TestFeeEstimator;
4305 let persister: test_utils::TestPersister;
4306 let logger: test_utils::TestLogger;
4307 let new_chain_monitor: test_utils::TestChainMonitor;
4308 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4309 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4311 // Start creating a channel, but stop right before broadcasting the funding transaction
4312 let channel_value = 100000;
4313 let push_msat = 10001;
4314 let a_flags = InitFeatures::known();
4315 let b_flags = InitFeatures::known();
4316 let node_a = nodes.remove(0);
4317 let node_b = nodes.remove(0);
4318 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4319 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()));
4320 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()));
4322 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4324 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4325 check_added_monitors!(node_a, 0);
4327 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()));
4329 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4330 assert_eq!(added_monitors.len(), 1);
4331 assert_eq!(added_monitors[0].0, funding_output);
4332 added_monitors.clear();
4335 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()));
4337 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4338 assert_eq!(added_monitors.len(), 1);
4339 assert_eq!(added_monitors[0].0, funding_output);
4340 added_monitors.clear();
4342 // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4347 // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4348 let nodes_0_serialized = nodes[0].node.encode();
4349 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4350 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4352 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4353 logger = test_utils::TestLogger::new();
4354 persister = test_utils::TestPersister::new();
4355 let keys_manager = &chanmon_cfgs[0].keys_manager;
4356 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4357 nodes[0].chain_monitor = &new_chain_monitor;
4358 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4359 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4360 &mut chan_0_monitor_read, keys_manager).unwrap();
4361 assert!(chan_0_monitor_read.is_empty());
4363 let mut nodes_0_read = &nodes_0_serialized[..];
4364 let config = UserConfig::default();
4365 let (_, nodes_0_deserialized_tmp) = {
4366 let mut channel_monitors = HashMap::new();
4367 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4368 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4369 default_config: config,
4371 fee_estimator: &fee_estimator,
4372 chain_monitor: nodes[0].chain_monitor,
4373 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4378 nodes_0_deserialized = nodes_0_deserialized_tmp;
4379 assert!(nodes_0_read.is_empty());
4381 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4383 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4384 nodes[0].node = &nodes_0_deserialized;
4386 // After deserializing, make sure the funding_transaction is still held by the channel manager
4387 let events_4 = nodes[0].node.get_and_clear_pending_events();
4388 assert_eq!(events_4.len(), 0);
4389 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4390 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4392 // Make sure the channel is functioning as though the de/serialization never happened
4393 assert_eq!(nodes[0].node.list_channels().len(), 1);
4394 check_added_monitors!(nodes[0], 1);
4396 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4397 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4398 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4399 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4401 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4402 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4403 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4404 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4406 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4407 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4408 for node in nodes.iter() {
4409 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4410 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4411 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4414 send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4418 fn test_simple_manager_serialize_deserialize() {
4419 let chanmon_cfgs = create_chanmon_cfgs(2);
4420 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4421 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4422 let logger: test_utils::TestLogger;
4423 let fee_estimator: test_utils::TestFeeEstimator;
4424 let persister: test_utils::TestPersister;
4425 let new_chain_monitor: test_utils::TestChainMonitor;
4426 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4427 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4428 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4430 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4431 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4433 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4435 let nodes_0_serialized = nodes[0].node.encode();
4436 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4437 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4439 logger = test_utils::TestLogger::new();
4440 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4441 persister = test_utils::TestPersister::new();
4442 let keys_manager = &chanmon_cfgs[0].keys_manager;
4443 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4444 nodes[0].chain_monitor = &new_chain_monitor;
4445 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4446 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4447 &mut chan_0_monitor_read, keys_manager).unwrap();
4448 assert!(chan_0_monitor_read.is_empty());
4450 let mut nodes_0_read = &nodes_0_serialized[..];
4451 let (_, nodes_0_deserialized_tmp) = {
4452 let mut channel_monitors = HashMap::new();
4453 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4454 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4455 default_config: UserConfig::default(),
4457 fee_estimator: &fee_estimator,
4458 chain_monitor: nodes[0].chain_monitor,
4459 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4464 nodes_0_deserialized = nodes_0_deserialized_tmp;
4465 assert!(nodes_0_read.is_empty());
4467 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4468 nodes[0].node = &nodes_0_deserialized;
4469 check_added_monitors!(nodes[0], 1);
4471 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4473 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4474 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4478 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4479 // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4480 let chanmon_cfgs = create_chanmon_cfgs(4);
4481 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4482 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4483 let logger: test_utils::TestLogger;
4484 let fee_estimator: test_utils::TestFeeEstimator;
4485 let persister: test_utils::TestPersister;
4486 let new_chain_monitor: test_utils::TestChainMonitor;
4487 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4488 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4489 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4490 create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4491 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4493 let mut node_0_stale_monitors_serialized = Vec::new();
4494 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4495 let mut writer = test_utils::TestVecWriter(Vec::new());
4496 monitor.1.write(&mut writer).unwrap();
4497 node_0_stale_monitors_serialized.push(writer.0);
4500 let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4502 // Serialize the ChannelManager here, but the monitor we keep up-to-date
4503 let nodes_0_serialized = nodes[0].node.encode();
4505 route_payment(&nodes[0], &[&nodes[3]], 1000000);
4506 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4507 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4508 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4510 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4512 let mut node_0_monitors_serialized = Vec::new();
4513 for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4514 let mut writer = test_utils::TestVecWriter(Vec::new());
4515 monitor.1.write(&mut writer).unwrap();
4516 node_0_monitors_serialized.push(writer.0);
4519 logger = test_utils::TestLogger::new();
4520 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4521 persister = test_utils::TestPersister::new();
4522 let keys_manager = &chanmon_cfgs[0].keys_manager;
4523 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4524 nodes[0].chain_monitor = &new_chain_monitor;
4527 let mut node_0_stale_monitors = Vec::new();
4528 for serialized in node_0_stale_monitors_serialized.iter() {
4529 let mut read = &serialized[..];
4530 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4531 assert!(read.is_empty());
4532 node_0_stale_monitors.push(monitor);
4535 let mut node_0_monitors = Vec::new();
4536 for serialized in node_0_monitors_serialized.iter() {
4537 let mut read = &serialized[..];
4538 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4539 assert!(read.is_empty());
4540 node_0_monitors.push(monitor);
4543 let mut nodes_0_read = &nodes_0_serialized[..];
4544 if let Err(msgs::DecodeError::InvalidValue) =
4545 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4546 default_config: UserConfig::default(),
4548 fee_estimator: &fee_estimator,
4549 chain_monitor: nodes[0].chain_monitor,
4550 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4552 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4554 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4557 let mut nodes_0_read = &nodes_0_serialized[..];
4558 let (_, nodes_0_deserialized_tmp) =
4559 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4560 default_config: UserConfig::default(),
4562 fee_estimator: &fee_estimator,
4563 chain_monitor: nodes[0].chain_monitor,
4564 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4566 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4568 nodes_0_deserialized = nodes_0_deserialized_tmp;
4569 assert!(nodes_0_read.is_empty());
4571 { // Channel close should result in a commitment tx and an HTLC tx
4572 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4573 assert_eq!(txn.len(), 2);
4574 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4575 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4578 for monitor in node_0_monitors.drain(..) {
4579 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4580 check_added_monitors!(nodes[0], 1);
4582 nodes[0].node = &nodes_0_deserialized;
4584 // nodes[1] and nodes[2] have no lost state with nodes[0]...
4585 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4586 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4587 //... and we can even still claim the payment!
4588 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4590 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4591 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4592 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4593 nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4594 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4595 assert_eq!(msg_events.len(), 1);
4596 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4598 &ErrorAction::SendErrorMessage { ref msg } => {
4599 assert_eq!(msg.channel_id, channel_id);
4601 _ => panic!("Unexpected event!"),
4606 macro_rules! check_spendable_outputs {
4607 ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4609 let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4610 let mut txn = Vec::new();
4611 let mut all_outputs = Vec::new();
4612 let secp_ctx = Secp256k1::new();
4613 for event in events.drain(..) {
4615 Event::SpendableOutputs { mut outputs } => {
4616 for outp in outputs.drain(..) {
4617 txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4618 all_outputs.push(outp);
4621 _ => panic!("Unexpected event"),
4624 if all_outputs.len() > 1 {
4625 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) {
4635 fn test_claim_sizeable_push_msat() {
4636 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4637 let chanmon_cfgs = create_chanmon_cfgs(2);
4638 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4639 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4640 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4642 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4643 nodes[1].node.force_close_channel(&chan.2).unwrap();
4644 check_closed_broadcast!(nodes[1], true);
4645 check_added_monitors!(nodes[1], 1);
4646 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4647 assert_eq!(node_txn.len(), 1);
4648 check_spends!(node_txn[0], chan.3);
4649 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
4651 mine_transaction(&nodes[1], &node_txn[0]);
4652 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4654 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4655 assert_eq!(spend_txn.len(), 1);
4656 check_spends!(spend_txn[0], node_txn[0]);
4660 fn test_claim_on_remote_sizeable_push_msat() {
4661 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4662 // to_remote output is encumbered by a P2WPKH
4663 let chanmon_cfgs = create_chanmon_cfgs(2);
4664 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4665 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4666 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4668 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4669 nodes[0].node.force_close_channel(&chan.2).unwrap();
4670 check_closed_broadcast!(nodes[0], true);
4671 check_added_monitors!(nodes[0], 1);
4673 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4674 assert_eq!(node_txn.len(), 1);
4675 check_spends!(node_txn[0], chan.3);
4676 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
4678 mine_transaction(&nodes[1], &node_txn[0]);
4679 check_closed_broadcast!(nodes[1], true);
4680 check_added_monitors!(nodes[1], 1);
4681 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4683 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4684 assert_eq!(spend_txn.len(), 1);
4685 check_spends!(spend_txn[0], node_txn[0]);
4689 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4690 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4691 // to_remote output is encumbered by a P2WPKH
4693 let chanmon_cfgs = create_chanmon_cfgs(2);
4694 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4695 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4696 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4698 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4699 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4700 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4701 assert_eq!(revoked_local_txn[0].input.len(), 1);
4702 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4704 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4705 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4706 check_closed_broadcast!(nodes[1], true);
4707 check_added_monitors!(nodes[1], 1);
4709 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4710 mine_transaction(&nodes[1], &node_txn[0]);
4711 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4713 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4714 assert_eq!(spend_txn.len(), 3);
4715 check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4716 check_spends!(spend_txn[1], node_txn[0]);
4717 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4721 fn test_static_spendable_outputs_preimage_tx() {
4722 let chanmon_cfgs = create_chanmon_cfgs(2);
4723 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4724 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4725 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4727 // Create some initial channels
4728 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4730 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4732 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4733 assert_eq!(commitment_tx[0].input.len(), 1);
4734 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4736 // Settle A's commitment tx on B's chain
4737 assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4738 check_added_monitors!(nodes[1], 1);
4739 mine_transaction(&nodes[1], &commitment_tx[0]);
4740 check_added_monitors!(nodes[1], 1);
4741 let events = nodes[1].node.get_and_clear_pending_msg_events();
4743 MessageSendEvent::UpdateHTLCs { .. } => {},
4744 _ => panic!("Unexpected event"),
4747 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4748 _ => panic!("Unexepected event"),
4751 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4752 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4753 assert_eq!(node_txn.len(), 3);
4754 check_spends!(node_txn[0], commitment_tx[0]);
4755 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4756 check_spends!(node_txn[1], chan_1.3);
4757 check_spends!(node_txn[2], node_txn[1]);
4759 mine_transaction(&nodes[1], &node_txn[0]);
4760 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4762 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4763 assert_eq!(spend_txn.len(), 1);
4764 check_spends!(spend_txn[0], node_txn[0]);
4768 fn test_static_spendable_outputs_timeout_tx() {
4769 let chanmon_cfgs = create_chanmon_cfgs(2);
4770 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4771 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4772 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4774 // Create some initial channels
4775 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4777 // Rebalance the network a bit by relaying one payment through all the channels ...
4778 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4780 let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4782 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4783 assert_eq!(commitment_tx[0].input.len(), 1);
4784 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4786 // Settle A's commitment tx on B' chain
4787 mine_transaction(&nodes[1], &commitment_tx[0]);
4788 check_added_monitors!(nodes[1], 1);
4789 let events = nodes[1].node.get_and_clear_pending_msg_events();
4791 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4792 _ => panic!("Unexpected event"),
4795 // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4796 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4797 assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4798 check_spends!(node_txn[0], commitment_tx[0].clone());
4799 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4800 check_spends!(node_txn[1], chan_1.3.clone());
4801 check_spends!(node_txn[2], node_txn[1]);
4803 mine_transaction(&nodes[1], &node_txn[0]);
4804 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4805 expect_payment_failed!(nodes[1], our_payment_hash, true);
4807 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4808 assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4809 check_spends!(spend_txn[0], commitment_tx[0]);
4810 check_spends!(spend_txn[1], node_txn[0]);
4811 check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
4815 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4816 let chanmon_cfgs = create_chanmon_cfgs(2);
4817 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4818 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4819 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4821 // Create some initial channels
4822 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4824 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4825 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4826 assert_eq!(revoked_local_txn[0].input.len(), 1);
4827 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4829 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4831 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4832 check_closed_broadcast!(nodes[1], true);
4833 check_added_monitors!(nodes[1], 1);
4835 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4836 assert_eq!(node_txn.len(), 2);
4837 assert_eq!(node_txn[0].input.len(), 2);
4838 check_spends!(node_txn[0], revoked_local_txn[0]);
4840 mine_transaction(&nodes[1], &node_txn[0]);
4841 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4843 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4844 assert_eq!(spend_txn.len(), 1);
4845 check_spends!(spend_txn[0], node_txn[0]);
4849 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4850 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4851 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4852 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4853 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4854 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4856 // Create some initial channels
4857 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4859 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4860 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4861 assert_eq!(revoked_local_txn[0].input.len(), 1);
4862 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4864 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4866 // A will generate HTLC-Timeout from revoked commitment tx
4867 mine_transaction(&nodes[0], &revoked_local_txn[0]);
4868 check_closed_broadcast!(nodes[0], true);
4869 check_added_monitors!(nodes[0], 1);
4871 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4872 assert_eq!(revoked_htlc_txn.len(), 2);
4873 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4874 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4875 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4876 check_spends!(revoked_htlc_txn[1], chan_1.3);
4878 // B will generate justice tx from A's revoked commitment/HTLC tx
4879 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4880 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4881 check_closed_broadcast!(nodes[1], true);
4882 check_added_monitors!(nodes[1], 1);
4884 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4885 assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4886 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4887 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4888 // transactions next...
4889 assert_eq!(node_txn[0].input.len(), 3);
4890 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4892 assert_eq!(node_txn[1].input.len(), 2);
4893 check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
4894 if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4895 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4897 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4898 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4901 assert_eq!(node_txn[2].input.len(), 1);
4902 check_spends!(node_txn[2], chan_1.3);
4904 mine_transaction(&nodes[1], &node_txn[1]);
4905 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4907 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4908 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4909 assert_eq!(spend_txn.len(), 1);
4910 assert_eq!(spend_txn[0].input.len(), 1);
4911 check_spends!(spend_txn[0], node_txn[1]);
4915 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4916 let mut chanmon_cfgs = create_chanmon_cfgs(2);
4917 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4918 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4919 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4920 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4922 // Create some initial channels
4923 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4925 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4926 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4927 assert_eq!(revoked_local_txn[0].input.len(), 1);
4928 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4930 // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4931 assert_eq!(revoked_local_txn[0].output.len(), 2);
4933 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4935 // B will generate HTLC-Success from revoked commitment tx
4936 mine_transaction(&nodes[1], &revoked_local_txn[0]);
4937 check_closed_broadcast!(nodes[1], true);
4938 check_added_monitors!(nodes[1], 1);
4939 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4941 assert_eq!(revoked_htlc_txn.len(), 2);
4942 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4943 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4944 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4946 // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4947 let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4948 assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4950 // A will generate justice tx from B's revoked commitment/HTLC tx
4951 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4952 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4953 check_closed_broadcast!(nodes[0], true);
4954 check_added_monitors!(nodes[0], 1);
4956 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4957 assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4959 // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4960 // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4961 // transactions next...
4962 assert_eq!(node_txn[0].input.len(), 2);
4963 check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4964 if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4965 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4967 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4968 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4971 assert_eq!(node_txn[1].input.len(), 1);
4972 check_spends!(node_txn[1], revoked_htlc_txn[0]);
4974 check_spends!(node_txn[2], chan_1.3);
4976 mine_transaction(&nodes[0], &node_txn[1]);
4977 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
4979 // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4980 // didn't try to generate any new transactions.
4982 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4983 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
4984 assert_eq!(spend_txn.len(), 3);
4985 assert_eq!(spend_txn[0].input.len(), 1);
4986 check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4987 assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4988 check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
4989 check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
4993 fn test_onchain_to_onchain_claim() {
4994 // Test that in case of channel closure, we detect the state of output and claim HTLC
4995 // on downstream peer's remote commitment tx.
4996 // First, have C claim an HTLC against its own latest commitment transaction.
4997 // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4999 // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5002 let chanmon_cfgs = create_chanmon_cfgs(3);
5003 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5004 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5005 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5007 // Create some initial channels
5008 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5009 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5011 // Rebalance the network a bit by relaying one payment through all the channels ...
5012 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5013 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5015 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5016 let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5017 check_spends!(commitment_tx[0], chan_2.3);
5018 nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5019 check_added_monitors!(nodes[2], 1);
5020 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5021 assert!(updates.update_add_htlcs.is_empty());
5022 assert!(updates.update_fail_htlcs.is_empty());
5023 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5024 assert!(updates.update_fail_malformed_htlcs.is_empty());
5026 mine_transaction(&nodes[2], &commitment_tx[0]);
5027 check_closed_broadcast!(nodes[2], true);
5028 check_added_monitors!(nodes[2], 1);
5030 let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5031 assert_eq!(c_txn.len(), 3);
5032 assert_eq!(c_txn[0], c_txn[2]);
5033 assert_eq!(commitment_tx[0], c_txn[1]);
5034 check_spends!(c_txn[1], chan_2.3);
5035 check_spends!(c_txn[2], c_txn[1]);
5036 assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5037 assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5038 assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5039 assert_eq!(c_txn[0].lock_time, 0); // Success tx
5041 // 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
5042 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5043 connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5045 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5046 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5047 assert_eq!(b_txn.len(), 3);
5048 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5049 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5050 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5051 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5052 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5053 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5054 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5055 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5056 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5059 check_added_monitors!(nodes[1], 1);
5060 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5061 assert_eq!(msg_events.len(), 3);
5062 check_added_monitors!(nodes[1], 1);
5063 match msg_events[0] {
5064 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5065 _ => panic!("Unexpected event"),
5067 match msg_events[1] {
5068 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5069 _ => panic!("Unexpected event"),
5071 match msg_events[2] {
5072 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, .. } } => {
5073 assert!(update_add_htlcs.is_empty());
5074 assert!(update_fail_htlcs.is_empty());
5075 assert_eq!(update_fulfill_htlcs.len(), 1);
5076 assert!(update_fail_malformed_htlcs.is_empty());
5077 assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5079 _ => panic!("Unexpected event"),
5081 // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5082 let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5083 mine_transaction(&nodes[1], &commitment_tx[0]);
5084 let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5085 // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5086 assert_eq!(b_txn.len(), 3);
5087 check_spends!(b_txn[1], chan_1.3);
5088 check_spends!(b_txn[2], b_txn[1]);
5089 check_spends!(b_txn[0], commitment_tx[0]);
5090 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5091 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5092 assert_eq!(b_txn[0].lock_time, 0); // Success tx
5094 check_closed_broadcast!(nodes[1], true);
5095 check_added_monitors!(nodes[1], 1);
5099 fn test_duplicate_payment_hash_one_failure_one_success() {
5100 // Topology : A --> B --> C
5101 // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5102 let chanmon_cfgs = create_chanmon_cfgs(3);
5103 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5104 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5105 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5107 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5108 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5110 let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5112 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5113 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
5114 send_along_route_with_hash(&nodes[0], route, &[&nodes[1], &nodes[2]], 900000, duplicate_payment_hash);
5116 let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5117 assert_eq!(commitment_txn[0].input.len(), 1);
5118 check_spends!(commitment_txn[0], chan_2.3);
5120 mine_transaction(&nodes[1], &commitment_txn[0]);
5121 check_closed_broadcast!(nodes[1], true);
5122 check_added_monitors!(nodes[1], 1);
5124 let htlc_timeout_tx;
5125 { // Extract one of the two HTLC-Timeout transaction
5126 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5127 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5128 assert_eq!(node_txn.len(), 5);
5129 check_spends!(node_txn[0], commitment_txn[0]);
5130 assert_eq!(node_txn[0].input.len(), 1);
5131 check_spends!(node_txn[1], commitment_txn[0]);
5132 assert_eq!(node_txn[1].input.len(), 1);
5133 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5134 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5135 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5136 check_spends!(node_txn[2], chan_2.3);
5137 check_spends!(node_txn[3], node_txn[2]);
5138 check_spends!(node_txn[4], node_txn[2]);
5139 htlc_timeout_tx = node_txn[1].clone();
5142 nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5143 mine_transaction(&nodes[2], &commitment_txn[0]);
5144 check_added_monitors!(nodes[2], 3);
5145 let events = nodes[2].node.get_and_clear_pending_msg_events();
5147 MessageSendEvent::UpdateHTLCs { .. } => {},
5148 _ => panic!("Unexpected event"),
5151 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5152 _ => panic!("Unexepected event"),
5154 let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5155 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)
5156 check_spends!(htlc_success_txn[2], chan_2.3);
5157 check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5158 check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5159 assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5160 assert_eq!(htlc_success_txn[0].input.len(), 1);
5161 assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5162 assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5163 assert_eq!(htlc_success_txn[1].input.len(), 1);
5164 assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5165 assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5166 check_spends!(htlc_success_txn[0], commitment_txn[0]);
5167 check_spends!(htlc_success_txn[1], commitment_txn[0]);
5169 mine_transaction(&nodes[1], &htlc_timeout_tx);
5170 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5171 expect_pending_htlcs_forwardable!(nodes[1]);
5172 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5173 assert!(htlc_updates.update_add_htlcs.is_empty());
5174 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5175 assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5176 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5177 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5178 check_added_monitors!(nodes[1], 1);
5180 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5181 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5183 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5184 let events = nodes[0].node.get_and_clear_pending_msg_events();
5185 assert_eq!(events.len(), 1);
5187 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. } } => {
5189 _ => { panic!("Unexpected event"); }
5192 expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5194 // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5195 mine_transaction(&nodes[1], &htlc_success_txn[0]);
5196 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5197 assert!(updates.update_add_htlcs.is_empty());
5198 assert!(updates.update_fail_htlcs.is_empty());
5199 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5200 assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5201 assert!(updates.update_fail_malformed_htlcs.is_empty());
5202 check_added_monitors!(nodes[1], 1);
5204 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5205 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5207 let events = nodes[0].node.get_and_clear_pending_events();
5209 Event::PaymentSent { ref payment_preimage } => {
5210 assert_eq!(*payment_preimage, our_payment_preimage);
5212 _ => panic!("Unexpected event"),
5217 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5218 let chanmon_cfgs = create_chanmon_cfgs(2);
5219 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5220 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5221 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5223 // Create some initial channels
5224 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5226 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5227 let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5228 assert_eq!(local_txn.len(), 1);
5229 assert_eq!(local_txn[0].input.len(), 1);
5230 check_spends!(local_txn[0], chan_1.3);
5232 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5233 nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5234 check_added_monitors!(nodes[1], 1);
5235 mine_transaction(&nodes[1], &local_txn[0]);
5236 check_added_monitors!(nodes[1], 1);
5237 let events = nodes[1].node.get_and_clear_pending_msg_events();
5239 MessageSendEvent::UpdateHTLCs { .. } => {},
5240 _ => panic!("Unexpected event"),
5243 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5244 _ => panic!("Unexepected event"),
5247 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5248 assert_eq!(node_txn.len(), 3);
5249 assert_eq!(node_txn[0], node_txn[2]);
5250 assert_eq!(node_txn[1], local_txn[0]);
5251 assert_eq!(node_txn[0].input.len(), 1);
5252 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5253 check_spends!(node_txn[0], local_txn[0]);
5257 mine_transaction(&nodes[1], &node_tx);
5258 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5260 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5261 let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5262 assert_eq!(spend_txn.len(), 1);
5263 check_spends!(spend_txn[0], node_tx);
5266 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5267 // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5268 // unrevoked commitment transaction.
5269 // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5270 // a remote RAA before they could be failed backwards (and combinations thereof).
5271 // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5272 // use the same payment hashes.
5273 // Thus, we use a six-node network:
5278 // And test where C fails back to A/B when D announces its latest commitment transaction
5279 let chanmon_cfgs = create_chanmon_cfgs(6);
5280 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5281 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5282 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5283 let logger = test_utils::TestLogger::new();
5285 create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5286 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5287 let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5288 create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5289 create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5291 // Rebalance and check output sanity...
5292 send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5293 send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5294 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5296 let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5298 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
5300 let (_, payment_hash_2, payment_secret_2) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], ds_dust_limit*1000); // not added < dust limit + HTLC tx fee
5301 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5302 let our_node_id = &nodes[1].node.get_our_node_id();
5303 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5305 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
5307 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
5309 let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5311 let (_, payment_hash_4, payment_secret_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5312 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5314 send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5316 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5319 let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5321 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5322 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
5325 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
5327 let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5328 send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5330 // Double-check that six of the new HTLC were added
5331 // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5332 // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5333 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5334 assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5336 // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5337 // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5338 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5339 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5340 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5341 assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5342 check_added_monitors!(nodes[4], 0);
5343 expect_pending_htlcs_forwardable!(nodes[4]);
5344 check_added_monitors!(nodes[4], 1);
5346 let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5347 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5348 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5349 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5350 nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5351 commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5353 // Fail 3rd below-dust and 7th above-dust HTLCs
5354 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5355 assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5356 check_added_monitors!(nodes[5], 0);
5357 expect_pending_htlcs_forwardable!(nodes[5]);
5358 check_added_monitors!(nodes[5], 1);
5360 let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5361 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5362 nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5363 commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5365 let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5367 expect_pending_htlcs_forwardable!(nodes[3]);
5368 check_added_monitors!(nodes[3], 1);
5369 let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5370 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5371 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5372 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5373 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5374 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5375 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5376 if deliver_last_raa {
5377 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5379 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5382 // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5383 // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5384 // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5385 // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5387 // We now broadcast the latest commitment transaction, which *should* result in failures for
5388 // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5389 // the non-broadcast above-dust HTLCs.
5391 // Alternatively, we may broadcast the previous commitment transaction, which should only
5392 // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5393 let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5395 if announce_latest {
5396 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5398 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5400 connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5401 check_closed_broadcast!(nodes[2], true);
5402 expect_pending_htlcs_forwardable!(nodes[2]);
5403 check_added_monitors!(nodes[2], 3);
5405 let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5406 assert_eq!(cs_msgs.len(), 2);
5407 let mut a_done = false;
5408 for msg in cs_msgs {
5410 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5411 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5412 // should be failed-backwards here.
5413 let target = if *node_id == nodes[0].node.get_our_node_id() {
5414 // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5415 for htlc in &updates.update_fail_htlcs {
5416 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 });
5418 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5423 // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5424 for htlc in &updates.update_fail_htlcs {
5425 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5427 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5428 assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5431 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5432 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5433 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5434 if announce_latest {
5435 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5436 if *node_id == nodes[0].node.get_our_node_id() {
5437 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5440 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5442 _ => panic!("Unexpected event"),
5446 let as_events = nodes[0].node.get_and_clear_pending_events();
5447 assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5448 let mut as_failds = HashSet::new();
5449 for event in as_events.iter() {
5450 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5451 assert!(as_failds.insert(*payment_hash));
5452 if *payment_hash != payment_hash_2 {
5453 assert_eq!(*rejected_by_dest, deliver_last_raa);
5455 assert!(!rejected_by_dest);
5457 } else { panic!("Unexpected event"); }
5459 assert!(as_failds.contains(&payment_hash_1));
5460 assert!(as_failds.contains(&payment_hash_2));
5461 if announce_latest {
5462 assert!(as_failds.contains(&payment_hash_3));
5463 assert!(as_failds.contains(&payment_hash_5));
5465 assert!(as_failds.contains(&payment_hash_6));
5467 let bs_events = nodes[1].node.get_and_clear_pending_events();
5468 assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5469 let mut bs_failds = HashSet::new();
5470 for event in bs_events.iter() {
5471 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5472 assert!(bs_failds.insert(*payment_hash));
5473 if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5474 assert_eq!(*rejected_by_dest, deliver_last_raa);
5476 assert!(!rejected_by_dest);
5478 } else { panic!("Unexpected event"); }
5480 assert!(bs_failds.contains(&payment_hash_1));
5481 assert!(bs_failds.contains(&payment_hash_2));
5482 if announce_latest {
5483 assert!(bs_failds.contains(&payment_hash_4));
5485 assert!(bs_failds.contains(&payment_hash_5));
5487 // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5488 // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5489 // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5490 // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5491 // PaymentFailureNetworkUpdates.
5492 let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5493 assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5494 let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5495 assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5496 for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5498 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5499 _ => panic!("Unexpected event"),
5505 fn test_fail_backwards_latest_remote_announce_a() {
5506 do_test_fail_backwards_unrevoked_remote_announce(false, true);
5510 fn test_fail_backwards_latest_remote_announce_b() {
5511 do_test_fail_backwards_unrevoked_remote_announce(true, true);
5515 fn test_fail_backwards_previous_remote_announce() {
5516 do_test_fail_backwards_unrevoked_remote_announce(false, false);
5517 // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5518 // tested for in test_commitment_revoked_fail_backward_exhaustive()
5522 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5523 let chanmon_cfgs = create_chanmon_cfgs(2);
5524 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5525 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5526 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5528 // Create some initial channels
5529 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5531 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5532 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5533 assert_eq!(local_txn[0].input.len(), 1);
5534 check_spends!(local_txn[0], chan_1.3);
5536 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5537 mine_transaction(&nodes[0], &local_txn[0]);
5538 check_closed_broadcast!(nodes[0], true);
5539 check_added_monitors!(nodes[0], 1);
5541 let htlc_timeout = {
5542 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5543 assert_eq!(node_txn[0].input.len(), 1);
5544 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5545 check_spends!(node_txn[0], local_txn[0]);
5549 mine_transaction(&nodes[0], &htlc_timeout);
5550 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5551 expect_payment_failed!(nodes[0], our_payment_hash, true);
5553 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5554 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5555 assert_eq!(spend_txn.len(), 3);
5556 check_spends!(spend_txn[0], local_txn[0]);
5557 check_spends!(spend_txn[1], htlc_timeout);
5558 check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5562 fn test_key_derivation_params() {
5563 // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5564 // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5565 // let us re-derive the channel key set to then derive a delayed_payment_key.
5567 let chanmon_cfgs = create_chanmon_cfgs(3);
5569 // We manually create the node configuration to backup the seed.
5570 let seed = [42; 32];
5571 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5572 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);
5573 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 };
5574 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5575 node_cfgs.remove(0);
5576 node_cfgs.insert(0, node);
5578 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5579 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5581 // Create some initial channels
5582 // Create a dummy channel to advance index by one and thus test re-derivation correctness
5584 let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5585 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5586 assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5588 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5589 let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5590 let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5591 assert_eq!(local_txn_1[0].input.len(), 1);
5592 check_spends!(local_txn_1[0], chan_1.3);
5594 // We check funding pubkey are unique
5595 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]));
5596 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]));
5597 if from_0_funding_key_0 == from_1_funding_key_0
5598 || from_0_funding_key_0 == from_1_funding_key_1
5599 || from_0_funding_key_1 == from_1_funding_key_0
5600 || from_0_funding_key_1 == from_1_funding_key_1 {
5601 panic!("Funding pubkeys aren't unique");
5604 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5605 mine_transaction(&nodes[0], &local_txn_1[0]);
5606 check_closed_broadcast!(nodes[0], true);
5607 check_added_monitors!(nodes[0], 1);
5609 let htlc_timeout = {
5610 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5611 assert_eq!(node_txn[0].input.len(), 1);
5612 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5613 check_spends!(node_txn[0], local_txn_1[0]);
5617 mine_transaction(&nodes[0], &htlc_timeout);
5618 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5619 expect_payment_failed!(nodes[0], our_payment_hash, true);
5621 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5622 let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5623 let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5624 assert_eq!(spend_txn.len(), 3);
5625 check_spends!(spend_txn[0], local_txn_1[0]);
5626 check_spends!(spend_txn[1], htlc_timeout);
5627 check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5631 fn test_static_output_closing_tx() {
5632 let chanmon_cfgs = create_chanmon_cfgs(2);
5633 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5634 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5635 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5637 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5639 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5640 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5642 mine_transaction(&nodes[0], &closing_tx);
5643 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5645 let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5646 assert_eq!(spend_txn.len(), 1);
5647 check_spends!(spend_txn[0], closing_tx);
5649 mine_transaction(&nodes[1], &closing_tx);
5650 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5652 let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5653 assert_eq!(spend_txn.len(), 1);
5654 check_spends!(spend_txn[0], closing_tx);
5657 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5658 let chanmon_cfgs = create_chanmon_cfgs(2);
5659 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5660 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5661 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5662 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5664 let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5666 // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5667 // present in B's local commitment transaction, but none of A's commitment transactions.
5668 assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5669 check_added_monitors!(nodes[1], 1);
5671 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5672 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5673 let events = nodes[0].node.get_and_clear_pending_events();
5674 assert_eq!(events.len(), 1);
5676 Event::PaymentSent { payment_preimage } => {
5677 assert_eq!(payment_preimage, our_payment_preimage);
5679 _ => panic!("Unexpected event"),
5682 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5683 check_added_monitors!(nodes[0], 1);
5684 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5685 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5686 check_added_monitors!(nodes[1], 1);
5688 let starting_block = nodes[1].best_block_info();
5689 let mut block = Block {
5690 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5693 for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5694 connect_block(&nodes[1], &block);
5695 block.header.prev_blockhash = block.block_hash();
5697 test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5698 check_closed_broadcast!(nodes[1], true);
5699 check_added_monitors!(nodes[1], 1);
5702 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5703 let chanmon_cfgs = create_chanmon_cfgs(2);
5704 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5705 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5706 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5707 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5708 let logger = test_utils::TestLogger::new();
5710 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5711 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5712 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5713 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5714 check_added_monitors!(nodes[0], 1);
5716 let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5718 // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5719 // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5720 // to "time out" the HTLC.
5722 let starting_block = nodes[1].best_block_info();
5723 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5725 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5726 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5727 header.prev_blockhash = header.block_hash();
5729 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5730 check_closed_broadcast!(nodes[0], true);
5731 check_added_monitors!(nodes[0], 1);
5734 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5735 let chanmon_cfgs = create_chanmon_cfgs(3);
5736 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5737 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5738 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5739 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5741 // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5742 // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5743 // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5744 // actually revoked.
5745 let htlc_value = if use_dust { 50000 } else { 3000000 };
5746 let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5747 assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5748 expect_pending_htlcs_forwardable!(nodes[1]);
5749 check_added_monitors!(nodes[1], 1);
5751 let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5752 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5753 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5754 check_added_monitors!(nodes[0], 1);
5755 let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5756 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5757 check_added_monitors!(nodes[1], 1);
5758 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5759 check_added_monitors!(nodes[1], 1);
5760 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5762 if check_revoke_no_close {
5763 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5764 check_added_monitors!(nodes[0], 1);
5767 let starting_block = nodes[1].best_block_info();
5768 let mut block = Block {
5769 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5772 for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5773 connect_block(&nodes[0], &block);
5774 block.header.prev_blockhash = block.block_hash();
5776 if !check_revoke_no_close {
5777 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5778 check_closed_broadcast!(nodes[0], true);
5779 check_added_monitors!(nodes[0], 1);
5781 expect_payment_failed!(nodes[0], our_payment_hash, true);
5785 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5786 // There are only a few cases to test here:
5787 // * its not really normative behavior, but we test that below-dust HTLCs "included" in
5788 // broadcastable commitment transactions result in channel closure,
5789 // * its included in an unrevoked-but-previous remote commitment transaction,
5790 // * its included in the latest remote or local commitment transactions.
5791 // We test each of the three possible commitment transactions individually and use both dust and
5793 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5794 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5795 // tested for at least one of the cases in other tests.
5797 fn htlc_claim_single_commitment_only_a() {
5798 do_htlc_claim_local_commitment_only(true);
5799 do_htlc_claim_local_commitment_only(false);
5801 do_htlc_claim_current_remote_commitment_only(true);
5802 do_htlc_claim_current_remote_commitment_only(false);
5806 fn htlc_claim_single_commitment_only_b() {
5807 do_htlc_claim_previous_remote_commitment_only(true, false);
5808 do_htlc_claim_previous_remote_commitment_only(false, false);
5809 do_htlc_claim_previous_remote_commitment_only(true, true);
5810 do_htlc_claim_previous_remote_commitment_only(false, true);
5815 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5816 let chanmon_cfgs = create_chanmon_cfgs(2);
5817 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5818 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5819 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5820 //Force duplicate channel ids
5821 for node in nodes.iter() {
5822 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5825 // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5826 let channel_value_satoshis=10000;
5827 let push_msat=10001;
5828 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5829 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5830 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5832 //Create a second channel with a channel_id collision
5833 assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5837 fn bolt2_open_channel_sending_node_checks_part2() {
5838 let chanmon_cfgs = create_chanmon_cfgs(2);
5839 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5840 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5841 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5843 // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5844 let channel_value_satoshis=2^24;
5845 let push_msat=10001;
5846 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5848 // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5849 let channel_value_satoshis=10000;
5850 // Test when push_msat is equal to 1000 * funding_satoshis.
5851 let push_msat=1000*channel_value_satoshis+1;
5852 assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5854 // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5855 let channel_value_satoshis=10000;
5856 let push_msat=10001;
5857 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
5858 let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5859 assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5861 // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5862 // 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
5863 assert!(node0_to_1_send_open_channel.channel_flags<=1);
5865 // 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.
5866 assert!(BREAKDOWN_TIMEOUT>0);
5867 assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5869 // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5870 let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5871 assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5873 // 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.
5874 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5875 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5876 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5877 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5878 assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5881 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5882 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5883 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5884 // is no longer affordable once it's freed.
5886 fn test_fail_holding_cell_htlc_upon_free() {
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 mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5891 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5892 let logger = test_utils::TestLogger::new();
5894 // First nodes[0] generates an update_fee, setting the channel's
5895 // pending_update_fee.
5896 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
5897 check_added_monitors!(nodes[0], 1);
5899 let events = nodes[0].node.get_and_clear_pending_msg_events();
5900 assert_eq!(events.len(), 1);
5901 let (update_msg, commitment_signed) = match events[0] {
5902 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5903 (update_fee.as_ref(), commitment_signed)
5905 _ => panic!("Unexpected event"),
5908 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5910 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5911 let channel_reserve = chan_stat.channel_reserve_msat;
5912 let feerate = get_feerate!(nodes[0], chan.2);
5914 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5915 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
5916 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
5917 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5918 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
5920 // Send a payment which passes reserve checks but gets stuck in the holding cell.
5921 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5922 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5923 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5925 // Flush the pending fee update.
5926 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5927 let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5928 check_added_monitors!(nodes[1], 1);
5929 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
5930 check_added_monitors!(nodes[0], 1);
5932 // Upon receipt of the RAA, there will be an attempt to resend the holding cell
5933 // HTLC, but now that the fee has been raised the payment will now fail, causing
5934 // us to surface its failure to the user.
5935 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5936 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5937 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
5938 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);
5939 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5941 // Check that the payment failed to be sent out.
5942 let events = nodes[0].node.get_and_clear_pending_events();
5943 assert_eq!(events.len(), 1);
5945 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
5946 assert_eq!(our_payment_hash.clone(), *payment_hash);
5947 assert_eq!(*rejected_by_dest, false);
5948 assert_eq!(*error_code, None);
5949 assert_eq!(*error_data, None);
5951 _ => panic!("Unexpected event"),
5955 // Test that if multiple HTLCs are released from the holding cell and one is
5956 // valid but the other is no longer valid upon release, the valid HTLC can be
5957 // successfully completed while the other one fails as expected.
5959 fn test_free_and_fail_holding_cell_htlcs() {
5960 let chanmon_cfgs = create_chanmon_cfgs(2);
5961 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5962 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5963 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5964 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5965 let logger = test_utils::TestLogger::new();
5967 // First nodes[0] generates an update_fee, setting the channel's
5968 // pending_update_fee.
5969 nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
5970 check_added_monitors!(nodes[0], 1);
5972 let events = nodes[0].node.get_and_clear_pending_msg_events();
5973 assert_eq!(events.len(), 1);
5974 let (update_msg, commitment_signed) = match events[0] {
5975 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5976 (update_fee.as_ref(), commitment_signed)
5978 _ => panic!("Unexpected event"),
5981 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5983 let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5984 let channel_reserve = chan_stat.channel_reserve_msat;
5985 let feerate = get_feerate!(nodes[0], chan.2);
5987 // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5988 let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
5990 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
5991 let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
5992 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5993 let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
5994 let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
5996 // Send 2 payments which pass reserve checks but get stuck in the holding cell.
5997 nodes[0].node.send_payment(&route_1, payment_hash_1, &None).unwrap();
5998 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5999 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6000 nodes[0].node.send_payment(&route_2, payment_hash_2, &None).unwrap();
6001 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6002 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6004 // Flush the pending fee update.
6005 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6006 let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6007 check_added_monitors!(nodes[1], 1);
6008 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6009 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6010 check_added_monitors!(nodes[0], 2);
6012 // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6013 // but now that the fee has been raised the second payment will now fail, causing us
6014 // to surface its failure to the user. The first payment should succeed.
6015 chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6016 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6017 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6018 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);
6019 nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6021 // Check that the second payment failed to be sent out.
6022 let events = nodes[0].node.get_and_clear_pending_events();
6023 assert_eq!(events.len(), 1);
6025 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6026 assert_eq!(payment_hash_2.clone(), *payment_hash);
6027 assert_eq!(*rejected_by_dest, false);
6028 assert_eq!(*error_code, None);
6029 assert_eq!(*error_data, None);
6031 _ => panic!("Unexpected event"),
6034 // Complete the first payment and the RAA from the fee update.
6035 let (payment_event, send_raa_event) = {
6036 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6037 assert_eq!(msgs.len(), 2);
6038 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6040 let raa = match send_raa_event {
6041 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6042 _ => panic!("Unexpected event"),
6044 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6045 check_added_monitors!(nodes[1], 1);
6046 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6047 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6048 let events = nodes[1].node.get_and_clear_pending_events();
6049 assert_eq!(events.len(), 1);
6051 Event::PendingHTLCsForwardable { .. } => {},
6052 _ => panic!("Unexpected event"),
6054 nodes[1].node.process_pending_htlc_forwards();
6055 let events = nodes[1].node.get_and_clear_pending_events();
6056 assert_eq!(events.len(), 1);
6058 Event::PaymentReceived { .. } => {},
6059 _ => panic!("Unexpected event"),
6061 nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
6062 check_added_monitors!(nodes[1], 1);
6063 let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6064 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6065 commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6066 let events = nodes[0].node.get_and_clear_pending_events();
6067 assert_eq!(events.len(), 1);
6069 Event::PaymentSent { ref payment_preimage } => {
6070 assert_eq!(*payment_preimage, payment_preimage_1);
6072 _ => panic!("Unexpected event"),
6076 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6077 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6078 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6081 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6082 let chanmon_cfgs = create_chanmon_cfgs(3);
6083 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6084 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6085 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6086 let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6087 let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6088 let logger = test_utils::TestLogger::new();
6090 // First nodes[1] generates an update_fee, setting the channel's
6091 // pending_update_fee.
6092 nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6093 check_added_monitors!(nodes[1], 1);
6095 let events = nodes[1].node.get_and_clear_pending_msg_events();
6096 assert_eq!(events.len(), 1);
6097 let (update_msg, commitment_signed) = match events[0] {
6098 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6099 (update_fee.as_ref(), commitment_signed)
6101 _ => panic!("Unexpected event"),
6104 nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6106 let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6107 let channel_reserve = chan_stat.channel_reserve_msat;
6108 let feerate = get_feerate!(nodes[0], chan_0_1.2);
6110 // Send a payment which passes reserve checks but gets stuck in the holding cell.
6112 let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6113 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6114 let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6115 let payment_event = {
6116 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6117 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6118 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6119 check_added_monitors!(nodes[0], 1);
6121 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6122 assert_eq!(events.len(), 1);
6124 SendEvent::from_event(events.remove(0))
6126 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6127 check_added_monitors!(nodes[1], 0);
6128 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6129 expect_pending_htlcs_forwardable!(nodes[1]);
6131 chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6132 assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6134 // Flush the pending fee update.
6135 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6136 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6137 check_added_monitors!(nodes[2], 1);
6138 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6139 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6140 check_added_monitors!(nodes[1], 2);
6142 // A final RAA message is generated to finalize the fee update.
6143 let events = nodes[1].node.get_and_clear_pending_msg_events();
6144 assert_eq!(events.len(), 1);
6146 let raa_msg = match &events[0] {
6147 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6150 _ => panic!("Unexpected event"),
6153 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6154 check_added_monitors!(nodes[2], 1);
6155 assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6157 // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6158 let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6159 assert_eq!(process_htlc_forwards_event.len(), 1);
6160 match &process_htlc_forwards_event[0] {
6161 &Event::PendingHTLCsForwardable { .. } => {},
6162 _ => panic!("Unexpected event"),
6165 // In response, we call ChannelManager's process_pending_htlc_forwards
6166 nodes[1].node.process_pending_htlc_forwards();
6167 check_added_monitors!(nodes[1], 1);
6169 // This causes the HTLC to be failed backwards.
6170 let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6171 assert_eq!(fail_event.len(), 1);
6172 let (fail_msg, commitment_signed) = match &fail_event[0] {
6173 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6174 assert_eq!(updates.update_add_htlcs.len(), 0);
6175 assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6176 assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6177 assert_eq!(updates.update_fail_htlcs.len(), 1);
6178 (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6180 _ => panic!("Unexpected event"),
6183 // Pass the failure messages back to nodes[0].
6184 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6185 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6187 // Complete the HTLC failure+removal process.
6188 let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6189 check_added_monitors!(nodes[0], 1);
6190 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6191 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6192 check_added_monitors!(nodes[1], 2);
6193 let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6194 assert_eq!(final_raa_event.len(), 1);
6195 let raa = match &final_raa_event[0] {
6196 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6197 _ => panic!("Unexpected event"),
6199 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6200 let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6201 assert_eq!(fail_msg_event.len(), 1);
6202 match &fail_msg_event[0] {
6203 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6204 _ => panic!("Unexpected event"),
6206 let failure_event = nodes[0].node.get_and_clear_pending_events();
6207 assert_eq!(failure_event.len(), 1);
6208 match &failure_event[0] {
6209 &Event::PaymentFailed { rejected_by_dest, .. } => {
6210 assert!(!rejected_by_dest);
6212 _ => panic!("Unexpected event"),
6214 check_added_monitors!(nodes[0], 1);
6217 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6218 // 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.
6219 //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.
6222 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6223 //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6224 let chanmon_cfgs = create_chanmon_cfgs(2);
6225 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6226 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6227 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6228 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6230 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6231 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6232 let logger = test_utils::TestLogger::new();
6233 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6234 route.paths[0][0].fee_msat = 100;
6236 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6237 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6238 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6239 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6243 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6244 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6245 let chanmon_cfgs = create_chanmon_cfgs(2);
6246 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6247 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6248 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6249 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6250 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6252 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6253 let logger = test_utils::TestLogger::new();
6254 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6255 route.paths[0][0].fee_msat = 0;
6256 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6257 assert_eq!(err, "Cannot send 0-msat HTLC"));
6259 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6260 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6264 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6265 //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6266 let chanmon_cfgs = create_chanmon_cfgs(2);
6267 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6268 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6269 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6270 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6272 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6273 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6274 let logger = test_utils::TestLogger::new();
6275 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6276 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6277 check_added_monitors!(nodes[0], 1);
6278 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6279 updates.update_add_htlcs[0].amount_msat = 0;
6281 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6282 nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6283 check_closed_broadcast!(nodes[1], true).unwrap();
6284 check_added_monitors!(nodes[1], 1);
6288 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6289 //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6290 //It is enforced when constructing a route.
6291 let chanmon_cfgs = create_chanmon_cfgs(2);
6292 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6293 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6294 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6295 let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6296 let logger = test_utils::TestLogger::new();
6298 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6300 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6301 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000000, 500000001, &logger).unwrap();
6302 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6303 assert_eq!(err, &"Channel CLTV overflowed?"));
6307 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6308 //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.
6309 //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6310 //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6311 let chanmon_cfgs = create_chanmon_cfgs(2);
6312 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6313 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6314 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6315 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6316 let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6318 let logger = test_utils::TestLogger::new();
6319 for i in 0..max_accepted_htlcs {
6320 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6321 let payment_event = {
6322 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6323 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6324 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6325 check_added_monitors!(nodes[0], 1);
6327 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6328 assert_eq!(events.len(), 1);
6329 if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6330 assert_eq!(htlcs[0].htlc_id, i);
6334 SendEvent::from_event(events.remove(0))
6336 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6337 check_added_monitors!(nodes[1], 0);
6338 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6340 expect_pending_htlcs_forwardable!(nodes[1]);
6341 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6343 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6344 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6345 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6346 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6347 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6349 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6350 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6354 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6355 //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.
6356 let chanmon_cfgs = create_chanmon_cfgs(2);
6357 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6358 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6359 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6360 let channel_value = 100000;
6361 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6362 let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6364 send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6366 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6367 // Manually create a route over our max in flight (which our router normally automatically
6369 let route = Route { paths: vec![vec![RouteHop {
6370 pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6371 short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6372 fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6374 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6375 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)));
6377 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6378 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);
6380 send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6383 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6385 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6386 //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6387 let chanmon_cfgs = create_chanmon_cfgs(2);
6388 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6389 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6390 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6391 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6392 let htlc_minimum_msat: u64;
6394 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6395 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6396 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6399 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6400 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6401 let logger = test_utils::TestLogger::new();
6402 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6403 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6404 check_added_monitors!(nodes[0], 1);
6405 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6406 updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6407 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6408 assert!(nodes[1].node.list_channels().is_empty());
6409 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6410 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()));
6411 check_added_monitors!(nodes[1], 1);
6415 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6416 //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
6417 let chanmon_cfgs = create_chanmon_cfgs(2);
6418 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6419 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6420 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6421 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6422 let logger = test_utils::TestLogger::new();
6424 let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6425 let channel_reserve = chan_stat.channel_reserve_msat;
6426 let feerate = get_feerate!(nodes[0], chan.2);
6427 // The 2* and +1 are for the fee spike reserve.
6428 let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6430 let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6431 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6432 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6433 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6434 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6435 check_added_monitors!(nodes[0], 1);
6436 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6438 // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6439 // at this time channel-initiatee receivers are not required to enforce that senders
6440 // respect the fee_spike_reserve.
6441 updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6442 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6444 assert!(nodes[1].node.list_channels().is_empty());
6445 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6446 assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6447 check_added_monitors!(nodes[1], 1);
6451 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6452 //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6453 //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6454 let chanmon_cfgs = create_chanmon_cfgs(2);
6455 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6456 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6457 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6458 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6459 let logger = test_utils::TestLogger::new();
6461 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6462 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6464 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6465 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6467 let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6468 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6469 let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6470 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6472 let mut msg = msgs::UpdateAddHTLC {
6476 payment_hash: our_payment_hash,
6477 cltv_expiry: htlc_cltv,
6478 onion_routing_packet: onion_packet.clone(),
6481 for i in 0..super::channel::OUR_MAX_HTLCS {
6482 msg.htlc_id = i as u64;
6483 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6485 msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6486 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6488 assert!(nodes[1].node.list_channels().is_empty());
6489 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6490 assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6491 check_added_monitors!(nodes[1], 1);
6495 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6496 //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6497 let chanmon_cfgs = create_chanmon_cfgs(2);
6498 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6499 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6500 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6501 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6502 let logger = test_utils::TestLogger::new();
6504 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6505 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6506 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6507 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6508 check_added_monitors!(nodes[0], 1);
6509 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6510 updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6511 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6513 assert!(nodes[1].node.list_channels().is_empty());
6514 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6515 assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6516 check_added_monitors!(nodes[1], 1);
6520 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6521 //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6522 let chanmon_cfgs = create_chanmon_cfgs(2);
6523 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6524 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6525 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6526 let logger = test_utils::TestLogger::new();
6528 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6529 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6530 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6531 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6532 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6533 check_added_monitors!(nodes[0], 1);
6534 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6535 updates.update_add_htlcs[0].cltv_expiry = 500000000;
6536 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6538 assert!(nodes[1].node.list_channels().is_empty());
6539 let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6540 assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6541 check_added_monitors!(nodes[1], 1);
6545 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6546 //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6547 // We test this by first testing that that repeated HTLCs pass commitment signature checks
6548 // after disconnect and that non-sequential htlc_ids result in a channel failure.
6549 let chanmon_cfgs = create_chanmon_cfgs(2);
6550 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6551 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6552 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6553 let logger = test_utils::TestLogger::new();
6555 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6556 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6557 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6558 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6559 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6560 check_added_monitors!(nodes[0], 1);
6561 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6562 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6564 //Disconnect and Reconnect
6565 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6566 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6567 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6568 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6569 assert_eq!(reestablish_1.len(), 1);
6570 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6571 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6572 assert_eq!(reestablish_2.len(), 1);
6573 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6574 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6575 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6576 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6579 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6580 assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6581 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6582 check_added_monitors!(nodes[1], 1);
6583 let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
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(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6590 check_added_monitors!(nodes[1], 1);
6594 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6595 //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.
6597 let chanmon_cfgs = create_chanmon_cfgs(2);
6598 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6599 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6600 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6601 let logger = test_utils::TestLogger::new();
6602 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6603 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
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(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6606 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6608 check_added_monitors!(nodes[0], 1);
6609 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6610 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6612 let update_msg = msgs::UpdateFulfillHTLC{
6615 payment_preimage: our_payment_preimage,
6618 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6620 assert!(nodes[0].node.list_channels().is_empty());
6621 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6622 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()));
6623 check_added_monitors!(nodes[0], 1);
6627 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6628 //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.
6630 let chanmon_cfgs = create_chanmon_cfgs(2);
6631 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6632 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6633 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6634 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6635 let logger = test_utils::TestLogger::new();
6637 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6638 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6639 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6640 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6641 check_added_monitors!(nodes[0], 1);
6642 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6643 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6645 let update_msg = msgs::UpdateFailHTLC{
6648 reason: msgs::OnionErrorPacket { data: Vec::new()},
6651 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6653 assert!(nodes[0].node.list_channels().is_empty());
6654 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6655 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()));
6656 check_added_monitors!(nodes[0], 1);
6660 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6661 //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.
6663 let chanmon_cfgs = create_chanmon_cfgs(2);
6664 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6665 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6666 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6667 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6668 let logger = test_utils::TestLogger::new();
6670 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6671 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6672 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6673 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6674 check_added_monitors!(nodes[0], 1);
6675 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6676 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6677 let update_msg = msgs::UpdateFailMalformedHTLC{
6680 sha256_of_onion: [1; 32],
6681 failure_code: 0x8000,
6684 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6686 assert!(nodes[0].node.list_channels().is_empty());
6687 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6688 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()));
6689 check_added_monitors!(nodes[0], 1);
6693 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6694 //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6696 let chanmon_cfgs = create_chanmon_cfgs(2);
6697 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6698 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6699 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6700 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6702 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6704 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6705 check_added_monitors!(nodes[1], 1);
6707 let events = nodes[1].node.get_and_clear_pending_msg_events();
6708 assert_eq!(events.len(), 1);
6709 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6711 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, .. } } => {
6712 assert!(update_add_htlcs.is_empty());
6713 assert_eq!(update_fulfill_htlcs.len(), 1);
6714 assert!(update_fail_htlcs.is_empty());
6715 assert!(update_fail_malformed_htlcs.is_empty());
6716 assert!(update_fee.is_none());
6717 update_fulfill_htlcs[0].clone()
6719 _ => panic!("Unexpected event"),
6723 update_fulfill_msg.htlc_id = 1;
6725 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6727 assert!(nodes[0].node.list_channels().is_empty());
6728 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6729 assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6730 check_added_monitors!(nodes[0], 1);
6734 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6735 //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.
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 nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6741 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6743 let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6745 nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6746 check_added_monitors!(nodes[1], 1);
6748 let events = nodes[1].node.get_and_clear_pending_msg_events();
6749 assert_eq!(events.len(), 1);
6750 let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6752 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, .. } } => {
6753 assert!(update_add_htlcs.is_empty());
6754 assert_eq!(update_fulfill_htlcs.len(), 1);
6755 assert!(update_fail_htlcs.is_empty());
6756 assert!(update_fail_malformed_htlcs.is_empty());
6757 assert!(update_fee.is_none());
6758 update_fulfill_htlcs[0].clone()
6760 _ => panic!("Unexpected event"),
6764 update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6766 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6768 assert!(nodes[0].node.list_channels().is_empty());
6769 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6770 assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6771 check_added_monitors!(nodes[0], 1);
6775 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6776 //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.
6778 let chanmon_cfgs = create_chanmon_cfgs(2);
6779 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6780 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6781 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6782 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6783 let logger = test_utils::TestLogger::new();
6785 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6786 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6787 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6788 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6789 check_added_monitors!(nodes[0], 1);
6791 let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6792 updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6794 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6795 check_added_monitors!(nodes[1], 0);
6796 commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6798 let events = nodes[1].node.get_and_clear_pending_msg_events();
6800 let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6802 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, .. } } => {
6803 assert!(update_add_htlcs.is_empty());
6804 assert!(update_fulfill_htlcs.is_empty());
6805 assert!(update_fail_htlcs.is_empty());
6806 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6807 assert!(update_fee.is_none());
6808 update_fail_malformed_htlcs[0].clone()
6810 _ => panic!("Unexpected event"),
6813 update_msg.failure_code &= !0x8000;
6814 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6816 assert!(nodes[0].node.list_channels().is_empty());
6817 let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6818 assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6819 check_added_monitors!(nodes[0], 1);
6823 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6824 //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6825 // * 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.
6827 let chanmon_cfgs = create_chanmon_cfgs(3);
6828 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6829 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6830 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6831 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6832 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6833 let logger = test_utils::TestLogger::new();
6835 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6838 let mut payment_event = {
6839 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6840 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
6841 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6842 check_added_monitors!(nodes[0], 1);
6843 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6844 assert_eq!(events.len(), 1);
6845 SendEvent::from_event(events.remove(0))
6847 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6848 check_added_monitors!(nodes[1], 0);
6849 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6850 expect_pending_htlcs_forwardable!(nodes[1]);
6851 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6852 assert_eq!(events_2.len(), 1);
6853 check_added_monitors!(nodes[1], 1);
6854 payment_event = SendEvent::from_event(events_2.remove(0));
6855 assert_eq!(payment_event.msgs.len(), 1);
6858 payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6859 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6860 check_added_monitors!(nodes[2], 0);
6861 commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6863 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6864 assert_eq!(events_3.len(), 1);
6865 let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6867 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 } } => {
6868 assert!(update_add_htlcs.is_empty());
6869 assert!(update_fulfill_htlcs.is_empty());
6870 assert!(update_fail_htlcs.is_empty());
6871 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6872 assert!(update_fee.is_none());
6873 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6875 _ => panic!("Unexpected event"),
6879 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6881 check_added_monitors!(nodes[1], 0);
6882 commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6883 expect_pending_htlcs_forwardable!(nodes[1]);
6884 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6885 assert_eq!(events_4.len(), 1);
6887 //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6889 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, .. } } => {
6890 assert!(update_add_htlcs.is_empty());
6891 assert!(update_fulfill_htlcs.is_empty());
6892 assert_eq!(update_fail_htlcs.len(), 1);
6893 assert!(update_fail_malformed_htlcs.is_empty());
6894 assert!(update_fee.is_none());
6896 _ => panic!("Unexpected event"),
6899 check_added_monitors!(nodes[1], 1);
6902 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6903 // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6904 // 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
6905 // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6907 let mut chanmon_cfgs = create_chanmon_cfgs(2);
6908 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6909 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6910 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6911 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6912 let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6914 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6916 // We route 2 dust-HTLCs between A and B
6917 let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6918 let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6919 route_payment(&nodes[0], &[&nodes[1]], 1000000);
6921 // Cache one local commitment tx as previous
6922 let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6924 // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6925 assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
6926 check_added_monitors!(nodes[1], 0);
6927 expect_pending_htlcs_forwardable!(nodes[1]);
6928 check_added_monitors!(nodes[1], 1);
6930 let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6931 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6932 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6933 check_added_monitors!(nodes[0], 1);
6935 // Cache one local commitment tx as lastest
6936 let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6938 let events = nodes[0].node.get_and_clear_pending_msg_events();
6940 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6941 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6943 _ => panic!("Unexpected event"),
6946 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6947 assert_eq!(node_id, nodes[1].node.get_our_node_id());
6949 _ => panic!("Unexpected event"),
6952 assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6953 // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6954 if announce_latest {
6955 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
6957 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
6960 check_closed_broadcast!(nodes[0], true);
6961 check_added_monitors!(nodes[0], 1);
6963 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6964 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6965 let events = nodes[0].node.get_and_clear_pending_events();
6966 // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6967 assert_eq!(events.len(), 2);
6968 let mut first_failed = false;
6969 for event in events {
6971 Event::PaymentFailed { payment_hash, .. } => {
6972 if payment_hash == payment_hash_1 {
6973 assert!(!first_failed);
6974 first_failed = true;
6976 assert_eq!(payment_hash, payment_hash_2);
6979 _ => panic!("Unexpected event"),
6985 fn test_failure_delay_dust_htlc_local_commitment() {
6986 do_test_failure_delay_dust_htlc_local_commitment(true);
6987 do_test_failure_delay_dust_htlc_local_commitment(false);
6990 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6991 // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6992 // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6993 // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6994 // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6995 // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6996 // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6998 let chanmon_cfgs = create_chanmon_cfgs(3);
6999 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7000 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7001 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7002 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7004 let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7006 let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7007 let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7009 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7010 let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7012 // We revoked bs_commitment_tx
7014 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7015 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7018 let mut timeout_tx = Vec::new();
7020 // We fail dust-HTLC 1 by broadcast of local commitment tx
7021 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7022 check_closed_broadcast!(nodes[0], true);
7023 check_added_monitors!(nodes[0], 1);
7024 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7025 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7026 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7027 expect_payment_failed!(nodes[0], dust_hash, true);
7028 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7029 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7030 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7031 mine_transaction(&nodes[0], &timeout_tx[0]);
7032 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7033 expect_payment_failed!(nodes[0], non_dust_hash, true);
7035 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7036 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7037 check_closed_broadcast!(nodes[0], true);
7038 check_added_monitors!(nodes[0], 1);
7039 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7040 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7041 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7043 expect_payment_failed!(nodes[0], dust_hash, true);
7044 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7045 // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7046 mine_transaction(&nodes[0], &timeout_tx[0]);
7047 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7048 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7049 expect_payment_failed!(nodes[0], non_dust_hash, true);
7051 // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7053 let events = nodes[0].node.get_and_clear_pending_events();
7054 assert_eq!(events.len(), 2);
7057 Event::PaymentFailed { payment_hash, .. } => {
7058 if payment_hash == dust_hash { first = true; }
7059 else { first = false; }
7061 _ => panic!("Unexpected event"),
7064 Event::PaymentFailed { payment_hash, .. } => {
7065 if first { assert_eq!(payment_hash, non_dust_hash); }
7066 else { assert_eq!(payment_hash, dust_hash); }
7068 _ => panic!("Unexpected event"),
7075 fn test_sweep_outbound_htlc_failure_update() {
7076 do_test_sweep_outbound_htlc_failure_update(false, true);
7077 do_test_sweep_outbound_htlc_failure_update(false, false);
7078 do_test_sweep_outbound_htlc_failure_update(true, false);
7082 fn test_upfront_shutdown_script() {
7083 // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7084 // enforce it at shutdown message
7086 let mut config = UserConfig::default();
7087 config.channel_options.announced_channel = true;
7088 config.peer_channel_config_limits.force_announced_channel_preference = false;
7089 config.channel_options.commit_upfront_shutdown_pubkey = false;
7090 let user_cfgs = [None, Some(config), None];
7091 let chanmon_cfgs = create_chanmon_cfgs(3);
7092 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7093 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7094 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7096 // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7097 let flags = InitFeatures::known();
7098 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7099 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7100 let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7101 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7102 // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that we disconnect peer
7103 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7104 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()));
7105 check_added_monitors!(nodes[2], 1);
7107 // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7108 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7109 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7110 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7111 // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7112 nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7113 let events = nodes[2].node.get_and_clear_pending_msg_events();
7114 assert_eq!(events.len(), 1);
7116 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7117 _ => panic!("Unexpected event"),
7120 // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7121 let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7122 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7123 nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7124 let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7125 node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7126 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7127 let events = nodes[1].node.get_and_clear_pending_msg_events();
7128 assert_eq!(events.len(), 1);
7130 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7131 _ => panic!("Unexpected event"),
7134 // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7135 // channel smoothly, opt-out is from channel initiator here
7136 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7137 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7138 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7139 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7140 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7141 let events = nodes[0].node.get_and_clear_pending_msg_events();
7142 assert_eq!(events.len(), 1);
7144 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7145 _ => panic!("Unexpected event"),
7148 //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7149 //// channel smoothly
7150 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7151 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7152 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7153 node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7154 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7155 let events = nodes[0].node.get_and_clear_pending_msg_events();
7156 assert_eq!(events.len(), 2);
7158 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7159 _ => panic!("Unexpected event"),
7162 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7163 _ => panic!("Unexpected event"),
7168 fn test_upfront_shutdown_script_unsupport_segwit() {
7169 // We test that channel is closed early
7170 // if a segwit program is passed as upfront shutdown script,
7171 // but the peer does not support segwit.
7172 let chanmon_cfgs = create_chanmon_cfgs(2);
7173 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7174 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7175 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7177 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7179 let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7180 open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7181 .push_slice(&[0, 0])
7184 let features = InitFeatures::known().clear_shutdown_anysegwit();
7185 nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7187 let events = nodes[0].node.get_and_clear_pending_msg_events();
7188 assert_eq!(events.len(), 1);
7190 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7191 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7192 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));
7194 _ => panic!("Unexpected event"),
7199 fn test_shutdown_script_any_segwit_allowed() {
7200 let mut config = UserConfig::default();
7201 config.channel_options.announced_channel = true;
7202 config.peer_channel_config_limits.force_announced_channel_preference = false;
7203 config.channel_options.commit_upfront_shutdown_pubkey = false;
7204 let user_cfgs = [None, Some(config), None];
7205 let chanmon_cfgs = create_chanmon_cfgs(3);
7206 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7207 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7208 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7210 //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7211 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7212 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7213 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7214 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7215 .push_slice(&[0, 0])
7217 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7218 let events = nodes[0].node.get_and_clear_pending_msg_events();
7219 assert_eq!(events.len(), 2);
7221 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7222 _ => panic!("Unexpected event"),
7225 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7226 _ => panic!("Unexpected event"),
7231 fn test_shutdown_script_any_segwit_not_allowed() {
7232 let mut config = UserConfig::default();
7233 config.channel_options.announced_channel = true;
7234 config.peer_channel_config_limits.force_announced_channel_preference = false;
7235 config.channel_options.commit_upfront_shutdown_pubkey = false;
7236 let user_cfgs = [None, Some(config), None];
7237 let chanmon_cfgs = create_chanmon_cfgs(3);
7238 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7239 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7240 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7242 //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7243 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7244 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7245 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7246 // Make an any segwit version script
7247 node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7248 .push_slice(&[0, 0])
7250 let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7251 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7252 let events = nodes[0].node.get_and_clear_pending_msg_events();
7253 assert_eq!(events.len(), 2);
7255 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7256 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7257 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7259 _ => panic!("Unexpected event"),
7261 check_added_monitors!(nodes[0], 1);
7265 fn test_shutdown_script_segwit_but_not_anysegwit() {
7266 let mut config = UserConfig::default();
7267 config.channel_options.announced_channel = true;
7268 config.peer_channel_config_limits.force_announced_channel_preference = false;
7269 config.channel_options.commit_upfront_shutdown_pubkey = false;
7270 let user_cfgs = [None, Some(config), None];
7271 let chanmon_cfgs = create_chanmon_cfgs(3);
7272 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7273 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7274 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7276 //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7277 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7278 nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7279 let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7280 // Make a segwit script that is not a valid as any segwit
7281 node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7282 .push_slice(&[0, 0])
7284 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7285 let events = nodes[0].node.get_and_clear_pending_msg_events();
7286 assert_eq!(events.len(), 2);
7288 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7289 assert_eq!(node_id, nodes[1].node.get_our_node_id());
7290 assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7292 _ => panic!("Unexpected event"),
7294 check_added_monitors!(nodes[0], 1);
7298 fn test_user_configurable_csv_delay() {
7299 // We test our channel constructors yield errors when we pass them absurd csv delay
7301 let mut low_our_to_self_config = UserConfig::default();
7302 low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7303 let mut high_their_to_self_config = UserConfig::default();
7304 high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7305 let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7306 let chanmon_cfgs = create_chanmon_cfgs(2);
7307 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7308 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7309 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7311 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7312 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) {
7314 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())); },
7315 _ => panic!("Unexpected event"),
7317 } else { assert!(false) }
7319 // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7320 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7321 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7322 open_channel.to_self_delay = 200;
7323 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) {
7325 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())); },
7326 _ => panic!("Unexpected event"),
7328 } else { assert!(false); }
7330 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7331 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7332 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()));
7333 let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7334 accept_channel.to_self_delay = 200;
7335 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7336 if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7338 &ErrorAction::SendErrorMessage { ref msg } => {
7339 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()));
7341 _ => { assert!(false); }
7343 } else { assert!(false); }
7345 // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7346 nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7347 let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7348 open_channel.to_self_delay = 200;
7349 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) {
7351 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())); },
7352 _ => panic!("Unexpected event"),
7354 } else { assert!(false); }
7358 fn test_data_loss_protect() {
7359 // We want to be sure that :
7360 // * we don't broadcast our Local Commitment Tx in case of fallen behind
7361 // (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7362 // * we close channel in case of detecting other being fallen behind
7363 // * we are able to claim our own outputs thanks to to_remote being static
7364 // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7370 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7371 // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7372 // during signing due to revoked tx
7373 chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7374 let keys_manager = &chanmon_cfgs[0].keys_manager;
7377 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7378 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7379 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7381 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7383 // Cache node A state before any channel update
7384 let previous_node_state = nodes[0].node.encode();
7385 let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7386 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7388 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7389 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7391 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7392 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7394 // Restore node A from previous state
7395 logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7396 let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7397 chain_source = test_utils::TestChainSource::new(Network::Testnet);
7398 tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7399 fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7400 persister = test_utils::TestPersister::new();
7401 monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7403 let mut channel_monitors = HashMap::new();
7404 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7405 <(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 {
7406 keys_manager: keys_manager,
7407 fee_estimator: &fee_estimator,
7408 chain_monitor: &monitor,
7410 tx_broadcaster: &tx_broadcaster,
7411 default_config: UserConfig::default(),
7415 nodes[0].node = &node_state_0;
7416 assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7417 nodes[0].chain_monitor = &monitor;
7418 nodes[0].chain_source = &chain_source;
7420 check_added_monitors!(nodes[0], 1);
7422 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7423 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7425 let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7427 // Check we don't broadcast any transactions following learning of per_commitment_point from B
7428 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7429 check_added_monitors!(nodes[0], 1);
7432 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7433 assert_eq!(node_txn.len(), 0);
7436 let mut reestablish_1 = Vec::with_capacity(1);
7437 for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7438 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7439 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7440 reestablish_1.push(msg.clone());
7441 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7442 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7444 &ErrorAction::SendErrorMessage { ref msg } => {
7445 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");
7447 _ => panic!("Unexpected event!"),
7450 panic!("Unexpected event")
7454 // Check we close channel detecting A is fallen-behind
7455 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7456 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7457 check_added_monitors!(nodes[1], 1);
7460 // Check A is able to claim to_remote output
7461 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7462 assert_eq!(node_txn.len(), 1);
7463 check_spends!(node_txn[0], chan.3);
7464 assert_eq!(node_txn[0].output.len(), 2);
7465 mine_transaction(&nodes[0], &node_txn[0]);
7466 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7467 let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7468 assert_eq!(spend_txn.len(), 1);
7469 check_spends!(spend_txn[0], node_txn[0]);
7473 fn test_check_htlc_underpaying() {
7474 // Send payment through A -> B but A is maliciously
7475 // sending a probe payment (i.e less than expected value0
7476 // to B, B should refuse payment.
7478 let chanmon_cfgs = create_chanmon_cfgs(2);
7479 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7480 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7481 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7483 // Create some initial channels
7484 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7486 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7488 // Node 3 is expecting payment of 100_000 but receive 10_000,
7489 // fail htlc like we didn't know the preimage.
7490 nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7491 nodes[1].node.process_pending_htlc_forwards();
7493 let events = nodes[1].node.get_and_clear_pending_msg_events();
7494 assert_eq!(events.len(), 1);
7495 let (update_fail_htlc, commitment_signed) = match events[0] {
7496 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 } } => {
7497 assert!(update_add_htlcs.is_empty());
7498 assert!(update_fulfill_htlcs.is_empty());
7499 assert_eq!(update_fail_htlcs.len(), 1);
7500 assert!(update_fail_malformed_htlcs.is_empty());
7501 assert!(update_fee.is_none());
7502 (update_fail_htlcs[0].clone(), commitment_signed)
7504 _ => panic!("Unexpected event"),
7506 check_added_monitors!(nodes[1], 1);
7508 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7509 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7511 // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7512 let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7513 expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7514 expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7515 nodes[1].node.get_and_clear_pending_events();
7519 fn test_announce_disable_channels() {
7520 // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7521 // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7523 let chanmon_cfgs = create_chanmon_cfgs(2);
7524 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7525 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7526 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7528 let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7529 let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7530 let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7533 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7534 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7536 nodes[0].node.timer_tick_occurred(); // dirty -> stagged
7537 nodes[0].node.timer_tick_occurred(); // staged -> fresh
7538 let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7539 assert_eq!(msg_events.len(), 3);
7540 for e in msg_events {
7542 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7543 let short_id = msg.contents.short_channel_id;
7544 // Check generated channel_update match list in PendingChannelUpdate
7545 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7546 panic!("Generated ChannelUpdate for wrong chan!");
7549 _ => panic!("Unexpected event"),
7553 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7554 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7555 assert_eq!(reestablish_1.len(), 3);
7556 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7557 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7558 assert_eq!(reestablish_2.len(), 3);
7560 // Reestablish chan_1
7561 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7562 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7563 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7564 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7565 // Reestablish chan_2
7566 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7567 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7568 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7569 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7570 // Reestablish chan_3
7571 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7572 handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7573 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7574 handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7576 nodes[0].node.timer_tick_occurred();
7577 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7581 fn test_bump_penalty_txn_on_revoked_commitment() {
7582 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7583 // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7585 let chanmon_cfgs = create_chanmon_cfgs(2);
7586 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7587 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7588 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7590 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7591 let logger = test_utils::TestLogger::new();
7593 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7594 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7595 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7596 send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7598 let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7599 // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7600 assert_eq!(revoked_txn[0].output.len(), 4);
7601 assert_eq!(revoked_txn[0].input.len(), 1);
7602 assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7603 let revoked_txid = revoked_txn[0].txid();
7605 let mut penalty_sum = 0;
7606 for outp in revoked_txn[0].output.iter() {
7607 if outp.script_pubkey.is_v0_p2wsh() {
7608 penalty_sum += outp.value;
7612 // Connect blocks to change height_timer range to see if we use right soonest_timelock
7613 let header_114 = connect_blocks(&nodes[1], 14);
7615 // Actually revoke tx by claiming a HTLC
7616 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7617 let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7618 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7619 check_added_monitors!(nodes[1], 1);
7621 // One or more justice tx should have been broadcast, check it
7625 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7626 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7627 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7628 assert_eq!(node_txn[0].output.len(), 1);
7629 check_spends!(node_txn[0], revoked_txn[0]);
7630 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7631 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7632 penalty_1 = node_txn[0].txid();
7636 // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7637 connect_blocks(&nodes[1], 15);
7638 let mut penalty_2 = penalty_1;
7639 let mut feerate_2 = 0;
7641 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7642 assert_eq!(node_txn.len(), 1);
7643 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7644 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7645 assert_eq!(node_txn[0].output.len(), 1);
7646 check_spends!(node_txn[0], revoked_txn[0]);
7647 penalty_2 = node_txn[0].txid();
7648 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7649 assert_ne!(penalty_2, penalty_1);
7650 let fee_2 = penalty_sum - node_txn[0].output[0].value;
7651 feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7652 // Verify 25% bump heuristic
7653 assert!(feerate_2 * 100 >= feerate_1 * 125);
7657 assert_ne!(feerate_2, 0);
7659 // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7660 connect_blocks(&nodes[1], 1);
7662 let mut feerate_3 = 0;
7664 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7665 assert_eq!(node_txn.len(), 1);
7666 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7667 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7668 assert_eq!(node_txn[0].output.len(), 1);
7669 check_spends!(node_txn[0], revoked_txn[0]);
7670 penalty_3 = node_txn[0].txid();
7671 // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7672 assert_ne!(penalty_3, penalty_2);
7673 let fee_3 = penalty_sum - node_txn[0].output[0].value;
7674 feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7675 // Verify 25% bump heuristic
7676 assert!(feerate_3 * 100 >= feerate_2 * 125);
7680 assert_ne!(feerate_3, 0);
7682 nodes[1].node.get_and_clear_pending_events();
7683 nodes[1].node.get_and_clear_pending_msg_events();
7687 fn test_bump_penalty_txn_on_revoked_htlcs() {
7688 // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7689 // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7691 let mut chanmon_cfgs = create_chanmon_cfgs(2);
7692 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7693 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7694 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7695 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7697 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7698 // Lock HTLC in both directions
7699 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7700 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7702 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7703 assert_eq!(revoked_local_txn[0].input.len(), 1);
7704 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7706 // Revoke local commitment tx
7707 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7709 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7710 // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7711 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7712 check_closed_broadcast!(nodes[1], true);
7713 check_added_monitors!(nodes[1], 1);
7715 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7716 assert_eq!(revoked_htlc_txn.len(), 4);
7717 if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7718 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7719 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7720 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7721 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7722 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7723 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7724 } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7725 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7726 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7727 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7728 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7729 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7730 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7733 // Broadcast set of revoked txn on A
7734 let hash_128 = connect_blocks(&nodes[0], 40);
7735 let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7736 connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7737 let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7738 connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] });
7739 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7744 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7745 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7746 // Verify claim tx are spending revoked HTLC txn
7748 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7749 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7750 // which are included in the same block (they are broadcasted because we scan the
7751 // transactions linearly and generate claims as we go, they likely should be removed in the
7753 assert_eq!(node_txn[0].input.len(), 1);
7754 check_spends!(node_txn[0], revoked_local_txn[0]);
7755 assert_eq!(node_txn[1].input.len(), 1);
7756 check_spends!(node_txn[1], revoked_local_txn[0]);
7757 assert_eq!(node_txn[2].input.len(), 1);
7758 check_spends!(node_txn[2], revoked_local_txn[0]);
7760 // Each of the three justice transactions claim a separate (single) output of the three
7761 // available, which we check here:
7762 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7763 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7764 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7766 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7767 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7769 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7770 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7771 // a remote commitment tx has already been confirmed).
7772 check_spends!(node_txn[3], chan.3);
7774 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7775 // output, checked above).
7776 assert_eq!(node_txn[4].input.len(), 2);
7777 assert_eq!(node_txn[4].output.len(), 1);
7778 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7780 first = node_txn[4].txid();
7781 // Store both feerates for later comparison
7782 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7783 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7784 penalty_txn = vec![node_txn[2].clone()];
7788 // Connect one more block to see if bumped penalty are issued for HTLC txn
7789 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7790 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7791 let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7792 connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7794 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7795 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7797 check_spends!(node_txn[0], revoked_local_txn[0]);
7798 check_spends!(node_txn[1], revoked_local_txn[0]);
7799 // Note that these are both bogus - they spend outputs already claimed in block 129:
7800 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output {
7801 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7803 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7804 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7810 // Few more blocks to confirm penalty txn
7811 connect_blocks(&nodes[0], 4);
7812 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7813 let header_144 = connect_blocks(&nodes[0], 9);
7815 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7816 assert_eq!(node_txn.len(), 1);
7818 assert_eq!(node_txn[0].input.len(), 2);
7819 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7820 // Verify bumped tx is different and 25% bump heuristic
7821 assert_ne!(first, node_txn[0].txid());
7822 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7823 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7824 assert!(feerate_2 * 100 > feerate_1 * 125);
7825 let txn = vec![node_txn[0].clone()];
7829 // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7830 let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7831 connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
7832 connect_blocks(&nodes[0], 20);
7834 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7835 // We verify than no new transaction has been broadcast because previously
7836 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7837 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7838 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7839 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7840 // up bumped justice generation.
7841 assert_eq!(node_txn.len(), 0);
7844 check_closed_broadcast!(nodes[0], true);
7845 check_added_monitors!(nodes[0], 1);
7849 fn test_bump_penalty_txn_on_remote_commitment() {
7850 // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7851 // we're able to claim outputs on remote commitment transaction before timelocks expiration
7854 // Provide preimage for one
7855 // Check aggregation
7857 let chanmon_cfgs = create_chanmon_cfgs(2);
7858 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7859 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7860 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7862 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7863 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7864 route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7866 // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7867 let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7868 assert_eq!(remote_txn[0].output.len(), 4);
7869 assert_eq!(remote_txn[0].input.len(), 1);
7870 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7872 // Claim a HTLC without revocation (provide B monitor with preimage)
7873 nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7874 mine_transaction(&nodes[1], &remote_txn[0]);
7875 check_added_monitors!(nodes[1], 2);
7877 // One or more claim tx should have been broadcast, check it
7880 let feerate_timeout;
7881 let feerate_preimage;
7883 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7884 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7885 assert_eq!(node_txn[0].input.len(), 1);
7886 assert_eq!(node_txn[1].input.len(), 1);
7887 check_spends!(node_txn[0], remote_txn[0]);
7888 check_spends!(node_txn[1], remote_txn[0]);
7889 check_spends!(node_txn[2], chan.3);
7890 check_spends!(node_txn[3], node_txn[2]);
7891 check_spends!(node_txn[4], node_txn[2]);
7892 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7893 timeout = node_txn[0].txid();
7894 let index = node_txn[0].input[0].previous_output.vout;
7895 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7896 feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7898 preimage = node_txn[1].txid();
7899 let index = node_txn[1].input[0].previous_output.vout;
7900 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7901 feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7903 timeout = node_txn[1].txid();
7904 let index = node_txn[1].input[0].previous_output.vout;
7905 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7906 feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7908 preimage = node_txn[0].txid();
7909 let index = node_txn[0].input[0].previous_output.vout;
7910 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7911 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7915 assert_ne!(feerate_timeout, 0);
7916 assert_ne!(feerate_preimage, 0);
7918 // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7919 connect_blocks(&nodes[1], 15);
7921 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7922 assert_eq!(node_txn.len(), 2);
7923 assert_eq!(node_txn[0].input.len(), 1);
7924 assert_eq!(node_txn[1].input.len(), 1);
7925 check_spends!(node_txn[0], remote_txn[0]);
7926 check_spends!(node_txn[1], remote_txn[0]);
7927 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7928 let index = node_txn[0].input[0].previous_output.vout;
7929 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7930 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7931 assert!(new_feerate * 100 > feerate_timeout * 125);
7932 assert_ne!(timeout, node_txn[0].txid());
7934 let index = node_txn[1].input[0].previous_output.vout;
7935 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7936 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7937 assert!(new_feerate * 100 > feerate_preimage * 125);
7938 assert_ne!(preimage, node_txn[1].txid());
7940 let index = node_txn[1].input[0].previous_output.vout;
7941 let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7942 let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7943 assert!(new_feerate * 100 > feerate_timeout * 125);
7944 assert_ne!(timeout, node_txn[1].txid());
7946 let index = node_txn[0].input[0].previous_output.vout;
7947 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7948 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7949 assert!(new_feerate * 100 > feerate_preimage * 125);
7950 assert_ne!(preimage, node_txn[0].txid());
7955 nodes[1].node.get_and_clear_pending_events();
7956 nodes[1].node.get_and_clear_pending_msg_events();
7960 fn test_counterparty_raa_skip_no_crash() {
7961 // Previously, if our counterparty sent two RAAs in a row without us having provided a
7962 // commitment transaction, we would have happily carried on and provided them the next
7963 // commitment transaction based on one RAA forward. This would probably eventually have led to
7964 // channel closure, but it would not have resulted in funds loss. Still, our
7965 // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
7966 // check simply that the channel is closed in response to such an RAA, but don't check whether
7967 // we decide to punish our counterparty for revoking their funds (as we don't currently
7969 let chanmon_cfgs = create_chanmon_cfgs(2);
7970 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7971 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7972 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7973 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
7975 let mut guard = nodes[0].node.channel_state.lock().unwrap();
7976 let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
7977 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7978 let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
7979 // Must revoke without gaps
7980 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
7981 let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7982 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7984 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7985 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7986 assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7987 check_added_monitors!(nodes[1], 1);
7991 fn test_bump_txn_sanitize_tracking_maps() {
7992 // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7993 // verify we clean then right after expiration of ANTI_REORG_DELAY.
7995 let chanmon_cfgs = create_chanmon_cfgs(2);
7996 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7997 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7998 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8000 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8001 // Lock HTLC in both directions
8002 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8003 route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8005 let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8006 assert_eq!(revoked_local_txn[0].input.len(), 1);
8007 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8009 // Revoke local commitment tx
8010 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8012 // Broadcast set of revoked txn on A
8013 connect_blocks(&nodes[0], 52 - CHAN_CONFIRM_DEPTH);
8014 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8015 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8017 mine_transaction(&nodes[0], &revoked_local_txn[0]);
8018 check_closed_broadcast!(nodes[0], true);
8019 check_added_monitors!(nodes[0], 1);
8021 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8022 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8023 check_spends!(node_txn[0], revoked_local_txn[0]);
8024 check_spends!(node_txn[1], revoked_local_txn[0]);
8025 check_spends!(node_txn[2], revoked_local_txn[0]);
8026 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8030 let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8031 connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8032 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8034 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8035 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8036 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8037 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8043 fn test_override_channel_config() {
8044 let chanmon_cfgs = create_chanmon_cfgs(2);
8045 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8046 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8047 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8049 // Node0 initiates a channel to node1 using the override config.
8050 let mut override_config = UserConfig::default();
8051 override_config.own_channel_config.our_to_self_delay = 200;
8053 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8055 // Assert the channel created by node0 is using the override config.
8056 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8057 assert_eq!(res.channel_flags, 0);
8058 assert_eq!(res.to_self_delay, 200);
8062 fn test_override_0msat_htlc_minimum() {
8063 let mut zero_config = UserConfig::default();
8064 zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8065 let chanmon_cfgs = create_chanmon_cfgs(2);
8066 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8067 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8068 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8070 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8071 let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8072 assert_eq!(res.htlc_minimum_msat, 1);
8074 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8075 let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8076 assert_eq!(res.htlc_minimum_msat, 1);
8080 fn test_simple_payment_secret() {
8081 // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8082 // features, however.
8083 let chanmon_cfgs = create_chanmon_cfgs(3);
8084 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8085 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8086 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8088 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8089 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8090 let logger = test_utils::TestLogger::new();
8092 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
8093 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8094 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();
8095 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8096 // Claiming with all the correct values but the wrong secret should result in nothing...
8097 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8098 assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8099 // ...but with the right secret we should be able to claim all the way back
8100 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8104 fn test_simple_mpp() {
8105 // Simple test of sending a multi-path payment.
8106 let chanmon_cfgs = create_chanmon_cfgs(4);
8107 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8108 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8109 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8111 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8112 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8113 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8114 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8115 let logger = test_utils::TestLogger::new();
8117 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8118 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8119 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8120 let path = route.paths[0].clone();
8121 route.paths.push(path);
8122 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8123 route.paths[0][0].short_channel_id = chan_1_id;
8124 route.paths[0][1].short_channel_id = chan_3_id;
8125 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8126 route.paths[1][0].short_channel_id = chan_2_id;
8127 route.paths[1][1].short_channel_id = chan_4_id;
8128 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8129 // Claiming with all the correct values but the wrong secret should result in nothing...
8130 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8131 assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8132 // ...but with the right secret we should be able to claim all the way back
8133 claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8137 fn test_update_err_monitor_lockdown() {
8138 // Our monitor will lock update of local commitment transaction if a broadcastion condition
8139 // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8140 // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8142 // This scenario may happen in a watchtower setup, where watchtower process a block height
8143 // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8144 // commitment at same time.
8146 let chanmon_cfgs = create_chanmon_cfgs(2);
8147 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8148 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8149 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8151 // Create some initial channel
8152 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8153 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8155 // Rebalance the network to generate htlc in the two directions
8156 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8158 // Route a HTLC from node 0 to node 1 (but don't settle)
8159 let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8161 // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8162 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8163 let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8164 let persister = test_utils::TestPersister::new();
8166 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8167 let monitor = monitors.get(&outpoint).unwrap();
8168 let mut w = test_utils::TestVecWriter(Vec::new());
8169 monitor.write(&mut w).unwrap();
8170 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8171 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8172 assert!(new_monitor == *monitor);
8173 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);
8174 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8177 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8178 watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8180 // Try to update ChannelMonitor
8181 assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8182 check_added_monitors!(nodes[1], 1);
8183 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8184 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8185 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8186 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8187 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8188 if let Err(_) = watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8189 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8190 } else { assert!(false); }
8191 } else { assert!(false); };
8192 // Our local monitor is in-sync and hasn't processed yet timeout
8193 check_added_monitors!(nodes[0], 1);
8194 let events = nodes[0].node.get_and_clear_pending_events();
8195 assert_eq!(events.len(), 1);
8199 fn test_concurrent_monitor_claim() {
8200 // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8201 // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8202 // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8203 // state N+1 confirms. Alice claims output from state N+1.
8205 let chanmon_cfgs = create_chanmon_cfgs(2);
8206 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8207 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8208 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8210 // Create some initial channel
8211 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8212 let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8214 // Rebalance the network to generate htlc in the two directions
8215 send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8217 // Route a HTLC from node 0 to node 1 (but don't settle)
8218 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8220 // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8221 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8222 let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8223 let persister = test_utils::TestPersister::new();
8224 let watchtower_alice = {
8225 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8226 let monitor = monitors.get(&outpoint).unwrap();
8227 let mut w = test_utils::TestVecWriter(Vec::new());
8228 monitor.write(&mut w).unwrap();
8229 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8230 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8231 assert!(new_monitor == *monitor);
8232 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);
8233 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8236 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8237 watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8239 // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8241 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8242 assert_eq!(txn.len(), 2);
8246 // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8247 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8248 let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8249 let persister = test_utils::TestPersister::new();
8250 let watchtower_bob = {
8251 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8252 let monitor = monitors.get(&outpoint).unwrap();
8253 let mut w = test_utils::TestVecWriter(Vec::new());
8254 monitor.write(&mut w).unwrap();
8255 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8256 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8257 assert!(new_monitor == *monitor);
8258 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);
8259 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8262 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8263 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8265 // Route another payment to generate another update with still previous HTLC pending
8266 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8268 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8269 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8270 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
8272 check_added_monitors!(nodes[1], 1);
8274 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8275 assert_eq!(updates.update_add_htlcs.len(), 1);
8276 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8277 if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8278 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8279 // Watchtower Alice should already have seen the block and reject the update
8280 if let Err(_) = watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8281 if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8282 if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8283 } else { assert!(false); }
8284 } else { assert!(false); };
8285 // Our local monitor is in-sync and hasn't processed yet timeout
8286 check_added_monitors!(nodes[0], 1);
8288 //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8289 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8290 watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8292 // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8295 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8296 assert_eq!(txn.len(), 2);
8297 bob_state_y = txn[0].clone();
8301 // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8302 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8303 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);
8305 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8306 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8307 // the onchain detection of the HTLC output
8308 assert_eq!(htlc_txn.len(), 2);
8309 check_spends!(htlc_txn[0], bob_state_y);
8310 check_spends!(htlc_txn[1], bob_state_y);
8315 fn test_pre_lockin_no_chan_closed_update() {
8316 // Test that if a peer closes a channel in response to a funding_created message we don't
8317 // generate a channel update (as the channel cannot appear on chain without a funding_signed
8320 // Doing so would imply a channel monitor update before the initial channel monitor
8321 // registration, violating our API guarantees.
8323 // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8324 // then opening a second channel with the same funding output as the first (which is not
8325 // rejected because the first channel does not exist in the ChannelManager) and closing it
8326 // before receiving funding_signed.
8327 let chanmon_cfgs = create_chanmon_cfgs(2);
8328 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8329 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8330 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8332 // Create an initial channel
8333 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8334 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8335 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8336 let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8337 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8339 // Move the first channel through the funding flow...
8340 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8342 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8343 check_added_monitors!(nodes[0], 0);
8345 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8346 let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8347 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8348 assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8352 fn test_htlc_no_detection() {
8353 // This test is a mutation to underscore the detection logic bug we had
8354 // before #653. HTLC value routed is above the remaining balance, thus
8355 // inverting HTLC and `to_remote` output. HTLC will come second and
8356 // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8357 // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8358 // outputs order detection for correct spending children filtring.
8360 let chanmon_cfgs = create_chanmon_cfgs(2);
8361 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8362 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8363 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8365 // Create some initial channels
8366 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8368 send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000, 1_000_000);
8369 let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8370 let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8371 assert_eq!(local_txn[0].input.len(), 1);
8372 assert_eq!(local_txn[0].output.len(), 3);
8373 check_spends!(local_txn[0], chan_1.3);
8375 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8376 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8377 connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8378 // We deliberately connect the local tx twice as this should provoke a failure calling
8379 // this test before #653 fix.
8380 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);
8381 check_closed_broadcast!(nodes[0], true);
8382 check_added_monitors!(nodes[0], 1);
8384 let htlc_timeout = {
8385 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8386 assert_eq!(node_txn[0].input.len(), 1);
8387 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8388 check_spends!(node_txn[0], local_txn[0]);
8392 let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8393 connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8394 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8395 expect_payment_failed!(nodes[0], our_payment_hash, true);
8398 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8399 // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8400 // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8401 // Carol, Alice would be the upstream node, and Carol the downstream.)
8403 // Steps of the test:
8404 // 1) Alice sends a HTLC to Carol through Bob.
8405 // 2) Carol doesn't settle the HTLC.
8406 // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8407 // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8408 // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8409 // but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8410 // 5) Carol release the preimage to Bob off-chain.
8411 // 6) Bob claims the offered output on the broadcasted commitment.
8412 let chanmon_cfgs = create_chanmon_cfgs(3);
8413 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8414 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8415 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8417 // Create some initial channels
8418 let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8419 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8421 // Steps (1) and (2):
8422 // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8423 let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8425 // Check that Alice's commitment transaction now contains an output for this HTLC.
8426 let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8427 check_spends!(alice_txn[0], chan_ab.3);
8428 assert_eq!(alice_txn[0].output.len(), 2);
8429 check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8430 assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8431 assert_eq!(alice_txn.len(), 2);
8433 // Steps (3) and (4):
8434 // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8435 // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8436 let mut force_closing_node = 0; // Alice force-closes
8437 if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8438 nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8439 check_closed_broadcast!(nodes[force_closing_node], true);
8440 check_added_monitors!(nodes[force_closing_node], 1);
8441 if go_onchain_before_fulfill {
8442 let txn_to_broadcast = match broadcast_alice {
8443 true => alice_txn.clone(),
8444 false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8446 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8447 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8448 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8449 if broadcast_alice {
8450 check_closed_broadcast!(nodes[1], true);
8451 check_added_monitors!(nodes[1], 1);
8453 assert_eq!(bob_txn.len(), 1);
8454 check_spends!(bob_txn[0], chan_ab.3);
8458 // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8459 // process of removing the HTLC from their commitment transactions.
8460 assert!(nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000));
8461 check_added_monitors!(nodes[2], 1);
8462 let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8463 assert!(carol_updates.update_add_htlcs.is_empty());
8464 assert!(carol_updates.update_fail_htlcs.is_empty());
8465 assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8466 assert!(carol_updates.update_fee.is_none());
8467 assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8469 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8470 // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8471 if !go_onchain_before_fulfill && broadcast_alice {
8472 let events = nodes[1].node.get_and_clear_pending_msg_events();
8473 assert_eq!(events.len(), 1);
8475 MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8476 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8478 _ => panic!("Unexpected event"),
8481 nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8482 // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8483 // Carol<->Bob's updated commitment transaction info.
8484 check_added_monitors!(nodes[1], 2);
8486 let events = nodes[1].node.get_and_clear_pending_msg_events();
8487 assert_eq!(events.len(), 2);
8488 let bob_revocation = match events[0] {
8489 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8490 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8493 _ => panic!("Unexpected event"),
8495 let bob_updates = match events[1] {
8496 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8497 assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8500 _ => panic!("Unexpected event"),
8503 nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8504 check_added_monitors!(nodes[2], 1);
8505 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8506 check_added_monitors!(nodes[2], 1);
8508 let events = nodes[2].node.get_and_clear_pending_msg_events();
8509 assert_eq!(events.len(), 1);
8510 let carol_revocation = match events[0] {
8511 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8512 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8515 _ => panic!("Unexpected event"),
8517 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8518 check_added_monitors!(nodes[1], 1);
8520 // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8521 // here's where we put said channel's commitment tx on-chain.
8522 let mut txn_to_broadcast = alice_txn.clone();
8523 if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8524 if !go_onchain_before_fulfill {
8525 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8526 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8527 // If Bob was the one to force-close, he will have already passed these checks earlier.
8528 if broadcast_alice {
8529 check_closed_broadcast!(nodes[1], true);
8530 check_added_monitors!(nodes[1], 1);
8532 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8533 if broadcast_alice {
8534 // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8535 // new block being connected. The ChannelManager being notified triggers a monitor update,
8536 // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8537 // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8539 assert_eq!(bob_txn.len(), 3);
8540 check_spends!(bob_txn[1], chan_ab.3);
8542 assert_eq!(bob_txn.len(), 2);
8543 check_spends!(bob_txn[0], chan_ab.3);
8548 // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8549 // broadcasted commitment transaction.
8551 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8552 if go_onchain_before_fulfill {
8553 // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8554 assert_eq!(bob_txn.len(), 2);
8556 let script_weight = match broadcast_alice {
8557 true => OFFERED_HTLC_SCRIPT_WEIGHT,
8558 false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8560 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8561 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8562 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8563 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8564 if broadcast_alice && !go_onchain_before_fulfill {
8565 check_spends!(bob_txn[0], txn_to_broadcast[0]);
8566 assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8568 check_spends!(bob_txn[1], txn_to_broadcast[0]);
8569 assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8575 fn test_onchain_htlc_settlement_after_close() {
8576 do_test_onchain_htlc_settlement_after_close(true, true);
8577 do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8578 do_test_onchain_htlc_settlement_after_close(true, false);
8579 do_test_onchain_htlc_settlement_after_close(false, false);
8583 fn test_duplicate_chan_id() {
8584 // Test that if a given peer tries to open a channel with the same channel_id as one that is
8585 // already open we reject it and keep the old channel.
8587 // Previously, full_stack_target managed to figure out that if you tried to open two channels
8588 // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8589 // the existing channel when we detect the duplicate new channel, screwing up our monitor
8590 // updating logic for the existing channel.
8591 let chanmon_cfgs = create_chanmon_cfgs(2);
8592 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8593 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8594 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8596 // Create an initial channel
8597 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8598 let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8599 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8600 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()));
8602 // Try to create a second channel with the same temporary_channel_id as the first and check
8603 // that it is rejected.
8604 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8606 let events = nodes[1].node.get_and_clear_pending_msg_events();
8607 assert_eq!(events.len(), 1);
8609 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8610 // Technically, at this point, nodes[1] would be justified in thinking both the
8611 // first (valid) and second (invalid) channels are closed, given they both have
8612 // the same non-temporary channel_id. However, currently we do not, so we just
8613 // move forward with it.
8614 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8615 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8617 _ => panic!("Unexpected event"),
8621 // Move the first channel through the funding flow...
8622 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8624 nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8625 check_added_monitors!(nodes[0], 0);
8627 let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8628 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8630 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8631 assert_eq!(added_monitors.len(), 1);
8632 assert_eq!(added_monitors[0].0, funding_output);
8633 added_monitors.clear();
8635 let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8637 let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8638 let channel_id = funding_outpoint.to_channel_id();
8640 // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8643 // First try to open a second channel with a temporary channel id equal to the txid-based one.
8644 // Technically this is allowed by the spec, but we don't support it and there's little reason
8645 // to. Still, it shouldn't cause any other issues.
8646 open_chan_msg.temporary_channel_id = channel_id;
8647 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8649 let events = nodes[1].node.get_and_clear_pending_msg_events();
8650 assert_eq!(events.len(), 1);
8652 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8653 // Technically, at this point, nodes[1] would be justified in thinking both
8654 // channels are closed, but currently we do not, so we just move forward with it.
8655 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8656 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8658 _ => panic!("Unexpected event"),
8662 // Now try to create a second channel which has a duplicate funding output.
8663 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8664 let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8665 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8666 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()));
8667 create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8669 let funding_created = {
8670 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8671 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8672 let logger = test_utils::TestLogger::new();
8673 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8675 check_added_monitors!(nodes[0], 0);
8676 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8677 // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8678 // still needs to be cleared here.
8679 check_added_monitors!(nodes[1], 1);
8681 // ...still, nodes[1] will reject the duplicate channel.
8683 let events = nodes[1].node.get_and_clear_pending_msg_events();
8684 assert_eq!(events.len(), 1);
8686 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8687 // Technically, at this point, nodes[1] would be justified in thinking both
8688 // channels are closed, but currently we do not, so we just move forward with it.
8689 assert_eq!(msg.channel_id, channel_id);
8690 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8692 _ => panic!("Unexpected event"),
8696 // finally, finish creating the original channel and send a payment over it to make sure
8697 // everything is functional.
8698 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8700 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8701 assert_eq!(added_monitors.len(), 1);
8702 assert_eq!(added_monitors[0].0, funding_output);
8703 added_monitors.clear();
8706 let events_4 = nodes[0].node.get_and_clear_pending_events();
8707 assert_eq!(events_4.len(), 0);
8708 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8709 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
8711 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8712 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8713 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8714 send_payment(&nodes[0], &[&nodes[1]], 8000000, 8_000_000);
8718 fn test_error_chans_closed() {
8719 // Test that we properly handle error messages, closing appropriate channels.
8721 // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8722 // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8723 // we can test various edge cases around it to ensure we don't regress.
8724 let chanmon_cfgs = create_chanmon_cfgs(3);
8725 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8726 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8727 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8729 // Create some initial channels
8730 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8731 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8732 let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8734 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8735 assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8736 assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8738 // Closing a channel from a different peer has no effect
8739 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8740 assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8742 // Closing one channel doesn't impact others
8743 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8744 check_added_monitors!(nodes[0], 1);
8745 check_closed_broadcast!(nodes[0], false);
8746 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
8747 assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8748 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);
8749 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);
8751 // A null channel ID should close all channels
8752 let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8753 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8754 check_added_monitors!(nodes[0], 2);
8755 let events = nodes[0].node.get_and_clear_pending_msg_events();
8756 assert_eq!(events.len(), 2);
8758 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8759 assert_eq!(msg.contents.flags & 2, 2);
8761 _ => panic!("Unexpected event"),
8764 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8765 assert_eq!(msg.contents.flags & 2, 2);
8767 _ => panic!("Unexpected event"),
8769 // Note that at this point users of a standard PeerHandler will end up calling
8770 // peer_disconnected with no_connection_possible set to false, duplicating the
8771 // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8772 // users with their own peer handling logic. We duplicate the call here, however.
8773 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8774 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8776 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8777 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8778 assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8782 fn test_invalid_funding_tx() {
8783 // Test that we properly handle invalid funding transactions sent to us from a peer.
8785 // Previously, all other major lightning implementations had failed to properly sanitize
8786 // funding transactions from their counterparties, leading to a multi-implementation critical
8787 // security vulnerability (though we always sanitized properly, we've previously had
8788 // un-released crashes in the sanitization process).
8789 let chanmon_cfgs = create_chanmon_cfgs(2);
8790 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8791 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8792 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8794 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
8795 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()));
8796 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()));
8798 let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
8799 for output in tx.output.iter_mut() {
8800 // Make the confirmed funding transaction have a bogus script_pubkey
8801 output.script_pubkey = bitcoin::Script::new();
8804 nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
8805 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()));
8806 check_added_monitors!(nodes[1], 1);
8808 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()));
8809 check_added_monitors!(nodes[0], 1);
8811 let events_1 = nodes[0].node.get_and_clear_pending_events();
8812 assert_eq!(events_1.len(), 0);
8814 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8815 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8816 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
8818 confirm_transaction_at(&nodes[1], &tx, 1);
8819 check_added_monitors!(nodes[1], 1);
8820 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
8821 assert_eq!(events_2.len(), 1);
8822 if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
8823 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8824 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
8825 assert_eq!(msg.data, "funding tx had wrong script/value or output index");
8826 } else { panic!(); }
8827 } else { panic!(); }
8828 assert_eq!(nodes[1].node.list_channels().len(), 0);