Merge pull request #1096 from valentinewallace/2021-09-mpp-retries
[rust-lightning] / lightning / src / ln / functional_tests.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
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
8 // licenses.
9
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.
13
14 use chain;
15 use chain::{Confirm, Listen, Watch};
16 use chain::channelmonitor;
17 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
18 use chain::transaction::OutPoint;
19 use chain::keysinterface::BaseSign;
20 use ln::{PaymentPreimage, PaymentSecret, PaymentHash};
21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, PaymentId, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
23 use ln::channel::{Channel, ChannelError};
24 use ln::{chan_utils, onion_utils};
25 use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
26 use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
27 use routing::network_graph::{NetworkUpdate, RoutingFees};
28 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
29 use ln::msgs;
30 use ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
31 use util::enforcing_trait_impls::EnforcingSigner;
32 use util::{byte_utils, test_utils};
33 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason};
34 use util::errors::APIError;
35 use util::ser::{Writeable, ReadableArgs};
36 use util::config::UserConfig;
37
38 use bitcoin::hash_types::{Txid, BlockHash};
39 use bitcoin::blockdata::block::{Block, BlockHeader};
40 use bitcoin::blockdata::script::Builder;
41 use bitcoin::blockdata::opcodes;
42 use bitcoin::blockdata::constants::genesis_block;
43 use bitcoin::network::constants::Network;
44
45 use bitcoin::hashes::sha256::Hash as Sha256;
46 use bitcoin::hashes::Hash;
47
48 use bitcoin::secp256k1::Secp256k1;
49 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
50
51 use regex;
52
53 use io;
54 use prelude::*;
55 use alloc::collections::BTreeSet;
56 use core::default::Default;
57 use sync::{Arc, Mutex};
58
59 use ln::functional_test_utils::*;
60 use ln::chan_utils::CommitmentTransaction;
61
62 #[test]
63 fn test_insane_channel_opens() {
64         // Stand up a network of 2 nodes
65         let chanmon_cfgs = create_chanmon_cfgs(2);
66         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
67         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
68         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
69
70         // Instantiate channel parameters where we push the maximum msats given our
71         // funding satoshis
72         let channel_value_sat = 31337; // same as funding satoshis
73         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
74         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
75
76         // Have node0 initiate a channel to node1 with aforementioned parameters
77         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
78
79         // Extract the channel open message from node0 to node1
80         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
81
82         // Test helper that asserts we get the correct error string given a mutator
83         // that supposedly makes the channel open message insane
84         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
85                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
86                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
87                 assert_eq!(msg_events.len(), 1);
88                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
89                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
90                         match action {
91                                 &ErrorAction::SendErrorMessage { .. } => {
92                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
93                                 },
94                                 _ => panic!("unexpected event!"),
95                         }
96                 } else { assert!(false); }
97         };
98
99         use ln::channel::MAX_FUNDING_SATOSHIS;
100         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
101
102         // Test all mutations that would make the channel open message insane
103         insane_open_helper(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, MAX_FUNDING_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
104
105         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
106
107         insane_open_helper(r"push_msat \d+ was larger than funding value \d+", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
108
109         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
110
111         insane_open_helper(r"Bogus; channel reserve \(\d+\) is less than dust limit \(\d+\)", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
112
113         insane_open_helper(r"Minimum htlc value \(\d+\) was larger than full channel value \(\d+\)", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
114
115         insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
116
117         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
118
119         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
120 }
121
122 #[test]
123 fn test_async_inbound_update_fee() {
124         let chanmon_cfgs = create_chanmon_cfgs(2);
125         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
126         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
127         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
128         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
129         let logger = test_utils::TestLogger::new();
130
131         // balancing
132         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
133
134         // A                                        B
135         // update_fee                            ->
136         // send (1) commitment_signed            -.
137         //                                       <- update_add_htlc/commitment_signed
138         // send (2) RAA (awaiting remote revoke) -.
139         // (1) commitment_signed is delivered    ->
140         //                                       .- send (3) RAA (awaiting remote revoke)
141         // (2) RAA is delivered                  ->
142         //                                       .- send (4) commitment_signed
143         //                                       <- (3) RAA is delivered
144         // send (5) commitment_signed            -.
145         //                                       <- (4) commitment_signed is delivered
146         // send (6) RAA                          -.
147         // (5) commitment_signed is delivered    ->
148         //                                       <- RAA
149         // (6) RAA is delivered                  ->
150
151         // First nodes[0] generates an update_fee
152         {
153                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
154                 *feerate_lock += 20;
155         }
156         nodes[0].node.timer_tick_occurred();
157         check_added_monitors!(nodes[0], 1);
158
159         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
160         assert_eq!(events_0.len(), 1);
161         let (update_msg, commitment_signed) = match events_0[0] { // (1)
162                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
163                         (update_fee.as_ref(), commitment_signed)
164                 },
165                 _ => panic!("Unexpected event"),
166         };
167
168         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
169
170         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
171         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
172         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
173         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
174         check_added_monitors!(nodes[1], 1);
175
176         let payment_event = {
177                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
178                 assert_eq!(events_1.len(), 1);
179                 SendEvent::from_event(events_1.remove(0))
180         };
181         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
182         assert_eq!(payment_event.msgs.len(), 1);
183
184         // ...now when the messages get delivered everyone should be happy
185         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
186         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
187         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
188         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
189         check_added_monitors!(nodes[0], 1);
190
191         // deliver(1), generate (3):
192         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
193         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
194         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
195         check_added_monitors!(nodes[1], 1);
196
197         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
198         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
199         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
200         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
201         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
202         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
203         assert!(bs_update.update_fee.is_none()); // (4)
204         check_added_monitors!(nodes[1], 1);
205
206         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
207         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
208         assert!(as_update.update_add_htlcs.is_empty()); // (5)
209         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
210         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
211         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
212         assert!(as_update.update_fee.is_none()); // (5)
213         check_added_monitors!(nodes[0], 1);
214
215         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
216         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
217         // only (6) so get_event_msg's assert(len == 1) passes
218         check_added_monitors!(nodes[0], 1);
219
220         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
221         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
222         check_added_monitors!(nodes[1], 1);
223
224         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
225         check_added_monitors!(nodes[0], 1);
226
227         let events_2 = nodes[0].node.get_and_clear_pending_events();
228         assert_eq!(events_2.len(), 1);
229         match events_2[0] {
230                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
231                 _ => panic!("Unexpected event"),
232         }
233
234         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
235         check_added_monitors!(nodes[1], 1);
236 }
237
238 #[test]
239 fn test_update_fee_unordered_raa() {
240         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
241         // crash in an earlier version of the update_fee patch)
242         let chanmon_cfgs = create_chanmon_cfgs(2);
243         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
244         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
245         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
246         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
247         let logger = test_utils::TestLogger::new();
248
249         // balancing
250         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
251
252         // First nodes[0] generates an update_fee
253         {
254                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
255                 *feerate_lock += 20;
256         }
257         nodes[0].node.timer_tick_occurred();
258         check_added_monitors!(nodes[0], 1);
259
260         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
261         assert_eq!(events_0.len(), 1);
262         let update_msg = match events_0[0] { // (1)
263                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
264                         update_fee.as_ref()
265                 },
266                 _ => panic!("Unexpected event"),
267         };
268
269         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
270
271         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
272         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
273         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
274         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
275         check_added_monitors!(nodes[1], 1);
276
277         let payment_event = {
278                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
279                 assert_eq!(events_1.len(), 1);
280                 SendEvent::from_event(events_1.remove(0))
281         };
282         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
283         assert_eq!(payment_event.msgs.len(), 1);
284
285         // ...now when the messages get delivered everyone should be happy
286         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
287         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
288         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
289         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
290         check_added_monitors!(nodes[0], 1);
291
292         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
293         check_added_monitors!(nodes[1], 1);
294
295         // We can't continue, sadly, because our (1) now has a bogus signature
296 }
297
298 #[test]
299 fn test_multi_flight_update_fee() {
300         let chanmon_cfgs = create_chanmon_cfgs(2);
301         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
302         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
303         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
304         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
305
306         // A                                        B
307         // update_fee/commitment_signed          ->
308         //                                       .- send (1) RAA and (2) commitment_signed
309         // update_fee (never committed)          ->
310         // (3) update_fee                        ->
311         // We have to manually generate the above update_fee, it is allowed by the protocol but we
312         // don't track which updates correspond to which revoke_and_ack responses so we're in
313         // AwaitingRAA mode and will not generate the update_fee yet.
314         //                                       <- (1) RAA delivered
315         // (3) is generated and send (4) CS      -.
316         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
317         // know the per_commitment_point to use for it.
318         //                                       <- (2) commitment_signed delivered
319         // revoke_and_ack                        ->
320         //                                          B should send no response here
321         // (4) commitment_signed delivered       ->
322         //                                       <- RAA/commitment_signed delivered
323         // revoke_and_ack                        ->
324
325         // First nodes[0] generates an update_fee
326         let initial_feerate;
327         {
328                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
329                 initial_feerate = *feerate_lock;
330                 *feerate_lock = initial_feerate + 20;
331         }
332         nodes[0].node.timer_tick_occurred();
333         check_added_monitors!(nodes[0], 1);
334
335         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
336         assert_eq!(events_0.len(), 1);
337         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
338                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
339                         (update_fee.as_ref().unwrap(), commitment_signed)
340                 },
341                 _ => panic!("Unexpected event"),
342         };
343
344         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
345         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
346         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
347         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
348         check_added_monitors!(nodes[1], 1);
349
350         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
351         // transaction:
352         {
353                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
354                 *feerate_lock = initial_feerate + 40;
355         }
356         nodes[0].node.timer_tick_occurred();
357         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
358         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
359
360         // Create the (3) update_fee message that nodes[0] will generate before it does...
361         let mut update_msg_2 = msgs::UpdateFee {
362                 channel_id: update_msg_1.channel_id.clone(),
363                 feerate_per_kw: (initial_feerate + 30) as u32,
364         };
365
366         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
367
368         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
369         // Deliver (3)
370         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
371
372         // Deliver (1), generating (3) and (4)
373         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
374         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
375         check_added_monitors!(nodes[0], 1);
376         assert!(as_second_update.update_add_htlcs.is_empty());
377         assert!(as_second_update.update_fulfill_htlcs.is_empty());
378         assert!(as_second_update.update_fail_htlcs.is_empty());
379         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
380         // Check that the update_fee newly generated matches what we delivered:
381         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
382         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
383
384         // Deliver (2) commitment_signed
385         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
386         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
387         check_added_monitors!(nodes[0], 1);
388         // No commitment_signed so get_event_msg's assert(len == 1) passes
389
390         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
391         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
392         check_added_monitors!(nodes[1], 1);
393
394         // Delever (4)
395         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
396         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
397         check_added_monitors!(nodes[1], 1);
398
399         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
400         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
401         check_added_monitors!(nodes[0], 1);
402
403         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
404         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
405         // No commitment_signed so get_event_msg's assert(len == 1) passes
406         check_added_monitors!(nodes[0], 1);
407
408         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
409         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
410         check_added_monitors!(nodes[1], 1);
411 }
412
413 fn do_test_1_conf_open(connect_style: ConnectStyle) {
414         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
415         // tests that we properly send one in that case.
416         let mut alice_config = UserConfig::default();
417         alice_config.own_channel_config.minimum_depth = 1;
418         alice_config.channel_options.announced_channel = true;
419         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
420         let mut bob_config = UserConfig::default();
421         bob_config.own_channel_config.minimum_depth = 1;
422         bob_config.channel_options.announced_channel = true;
423         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
424         let chanmon_cfgs = create_chanmon_cfgs(2);
425         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
426         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
427         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
428         *nodes[0].connect_style.borrow_mut() = connect_style;
429
430         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
431         mine_transaction(&nodes[1], &tx);
432         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
433
434         mine_transaction(&nodes[0], &tx);
435         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
436         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
437
438         for node in nodes {
439                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
440                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
441                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
442         }
443 }
444 #[test]
445 fn test_1_conf_open() {
446         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
447         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
448         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
449 }
450
451 fn do_test_sanity_on_in_flight_opens(steps: u8) {
452         // Previously, we had issues deserializing channels when we hadn't connected the first block
453         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
454         // serialization round-trips and simply do steps towards opening a channel and then drop the
455         // Node objects.
456
457         let chanmon_cfgs = create_chanmon_cfgs(2);
458         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
459         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
460         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
461
462         if steps & 0b1000_0000 != 0{
463                 let block = Block {
464                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
465                         txdata: vec![],
466                 };
467                 connect_block(&nodes[0], &block);
468                 connect_block(&nodes[1], &block);
469         }
470
471         if steps & 0x0f == 0 { return; }
472         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
473         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
474
475         if steps & 0x0f == 1 { return; }
476         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
477         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
478
479         if steps & 0x0f == 2 { return; }
480         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
481
482         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
483
484         if steps & 0x0f == 3 { return; }
485         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
486         check_added_monitors!(nodes[0], 0);
487         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
488
489         if steps & 0x0f == 4 { return; }
490         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
491         {
492                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
493                 assert_eq!(added_monitors.len(), 1);
494                 assert_eq!(added_monitors[0].0, funding_output);
495                 added_monitors.clear();
496         }
497         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
498
499         if steps & 0x0f == 5 { return; }
500         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
501         {
502                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
503                 assert_eq!(added_monitors.len(), 1);
504                 assert_eq!(added_monitors[0].0, funding_output);
505                 added_monitors.clear();
506         }
507
508         let events_4 = nodes[0].node.get_and_clear_pending_events();
509         assert_eq!(events_4.len(), 0);
510
511         if steps & 0x0f == 6 { return; }
512         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
513
514         if steps & 0x0f == 7 { return; }
515         confirm_transaction_at(&nodes[0], &tx, 2);
516         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
517         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
518 }
519
520 #[test]
521 fn test_sanity_on_in_flight_opens() {
522         do_test_sanity_on_in_flight_opens(0);
523         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
524         do_test_sanity_on_in_flight_opens(1);
525         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
526         do_test_sanity_on_in_flight_opens(2);
527         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
528         do_test_sanity_on_in_flight_opens(3);
529         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
530         do_test_sanity_on_in_flight_opens(4);
531         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
532         do_test_sanity_on_in_flight_opens(5);
533         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
534         do_test_sanity_on_in_flight_opens(6);
535         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
536         do_test_sanity_on_in_flight_opens(7);
537         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
538         do_test_sanity_on_in_flight_opens(8);
539         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
540 }
541
542 #[test]
543 fn test_update_fee_vanilla() {
544         let chanmon_cfgs = create_chanmon_cfgs(2);
545         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
546         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
547         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
548         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
549
550         {
551                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
552                 *feerate_lock += 25;
553         }
554         nodes[0].node.timer_tick_occurred();
555         check_added_monitors!(nodes[0], 1);
556
557         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
558         assert_eq!(events_0.len(), 1);
559         let (update_msg, commitment_signed) = match events_0[0] {
560                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
561                         (update_fee.as_ref(), commitment_signed)
562                 },
563                 _ => panic!("Unexpected event"),
564         };
565         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
566
567         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
568         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
569         check_added_monitors!(nodes[1], 1);
570
571         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
572         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
573         check_added_monitors!(nodes[0], 1);
574
575         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
576         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
577         // No commitment_signed so get_event_msg's assert(len == 1) passes
578         check_added_monitors!(nodes[0], 1);
579
580         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
581         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
582         check_added_monitors!(nodes[1], 1);
583 }
584
585 #[test]
586 fn test_update_fee_that_funder_cannot_afford() {
587         let chanmon_cfgs = create_chanmon_cfgs(2);
588         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
589         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
590         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
591         let channel_value = 1888;
592         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
593         let channel_id = chan.2;
594
595         let feerate = 260;
596         {
597                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
598                 *feerate_lock = feerate;
599         }
600         nodes[0].node.timer_tick_occurred();
601         check_added_monitors!(nodes[0], 1);
602         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
603
604         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
605
606         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
607
608         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
609         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
610         {
611                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
612
613                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
614                 let num_htlcs = commitment_tx.output.len() - 2;
615                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
616                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
617                 actual_fee = channel_value - actual_fee;
618                 assert_eq!(total_fee, actual_fee);
619         }
620
621         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
622         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
623         {
624                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
625                 *feerate_lock = feerate + 2;
626         }
627         nodes[0].node.timer_tick_occurred();
628         check_added_monitors!(nodes[0], 1);
629
630         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
631
632         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
633
634         //While producing the commitment_signed response after handling a received update_fee request the
635         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
636         //Should produce and error.
637         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
638         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
639         check_added_monitors!(nodes[1], 1);
640         check_closed_broadcast!(nodes[1], true);
641         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: String::from("Funding remote cannot afford proposed new fee") });
642 }
643
644 #[test]
645 fn test_update_fee_with_fundee_update_add_htlc() {
646         let chanmon_cfgs = create_chanmon_cfgs(2);
647         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
648         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
649         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
650         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
651         let logger = test_utils::TestLogger::new();
652
653         // balancing
654         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
655
656         {
657                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
658                 *feerate_lock += 20;
659         }
660         nodes[0].node.timer_tick_occurred();
661         check_added_monitors!(nodes[0], 1);
662
663         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
664         assert_eq!(events_0.len(), 1);
665         let (update_msg, commitment_signed) = match events_0[0] {
666                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
667                         (update_fee.as_ref(), commitment_signed)
668                 },
669                 _ => panic!("Unexpected event"),
670         };
671         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
672         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
673         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
674         check_added_monitors!(nodes[1], 1);
675
676         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
677         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
678         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
679
680         // nothing happens since node[1] is in AwaitingRemoteRevoke
681         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
682         {
683                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
684                 assert_eq!(added_monitors.len(), 0);
685                 added_monitors.clear();
686         }
687         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
688         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
689         // node[1] has nothing to do
690
691         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
692         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
693         check_added_monitors!(nodes[0], 1);
694
695         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
696         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
697         // No commitment_signed so get_event_msg's assert(len == 1) passes
698         check_added_monitors!(nodes[0], 1);
699         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
700         check_added_monitors!(nodes[1], 1);
701         // AwaitingRemoteRevoke ends here
702
703         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
704         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
705         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
706         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
707         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
708         assert_eq!(commitment_update.update_fee.is_none(), true);
709
710         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
711         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
712         check_added_monitors!(nodes[0], 1);
713         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
714
715         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
716         check_added_monitors!(nodes[1], 1);
717         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
718
719         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
720         check_added_monitors!(nodes[1], 1);
721         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
722         // No commitment_signed so get_event_msg's assert(len == 1) passes
723
724         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
725         check_added_monitors!(nodes[0], 1);
726         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
727
728         expect_pending_htlcs_forwardable!(nodes[0]);
729
730         let events = nodes[0].node.get_and_clear_pending_events();
731         assert_eq!(events.len(), 1);
732         match events[0] {
733                 Event::PaymentReceived { .. } => { },
734                 _ => panic!("Unexpected event"),
735         };
736
737         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
738
739         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
740         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
741         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
742         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
743         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
744 }
745
746 #[test]
747 fn test_update_fee() {
748         let chanmon_cfgs = create_chanmon_cfgs(2);
749         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
750         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
751         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
752         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
753         let channel_id = chan.2;
754
755         // A                                        B
756         // (1) update_fee/commitment_signed      ->
757         //                                       <- (2) revoke_and_ack
758         //                                       .- send (3) commitment_signed
759         // (4) update_fee/commitment_signed      ->
760         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
761         //                                       <- (3) commitment_signed delivered
762         // send (6) revoke_and_ack               -.
763         //                                       <- (5) deliver revoke_and_ack
764         // (6) deliver revoke_and_ack            ->
765         //                                       .- send (7) commitment_signed in response to (4)
766         //                                       <- (7) deliver commitment_signed
767         // revoke_and_ack                        ->
768
769         // Create and deliver (1)...
770         let feerate;
771         {
772                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
773                 feerate = *feerate_lock;
774                 *feerate_lock = feerate + 20;
775         }
776         nodes[0].node.timer_tick_occurred();
777         check_added_monitors!(nodes[0], 1);
778
779         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
780         assert_eq!(events_0.len(), 1);
781         let (update_msg, commitment_signed) = match events_0[0] {
782                         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 } } => {
783                         (update_fee.as_ref(), commitment_signed)
784                 },
785                 _ => panic!("Unexpected event"),
786         };
787         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
788
789         // Generate (2) and (3):
790         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
791         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
792         check_added_monitors!(nodes[1], 1);
793
794         // Deliver (2):
795         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
796         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
797         check_added_monitors!(nodes[0], 1);
798
799         // Create and deliver (4)...
800         {
801                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
802                 *feerate_lock = feerate + 30;
803         }
804         nodes[0].node.timer_tick_occurred();
805         check_added_monitors!(nodes[0], 1);
806         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
807         assert_eq!(events_0.len(), 1);
808         let (update_msg, commitment_signed) = match events_0[0] {
809                         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 } } => {
810                         (update_fee.as_ref(), commitment_signed)
811                 },
812                 _ => panic!("Unexpected event"),
813         };
814
815         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
816         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
817         check_added_monitors!(nodes[1], 1);
818         // ... creating (5)
819         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
820         // No commitment_signed so get_event_msg's assert(len == 1) passes
821
822         // Handle (3), creating (6):
823         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
824         check_added_monitors!(nodes[0], 1);
825         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
826         // No commitment_signed so get_event_msg's assert(len == 1) passes
827
828         // Deliver (5):
829         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
830         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
831         check_added_monitors!(nodes[0], 1);
832
833         // Deliver (6), creating (7):
834         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
835         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
836         assert!(commitment_update.update_add_htlcs.is_empty());
837         assert!(commitment_update.update_fulfill_htlcs.is_empty());
838         assert!(commitment_update.update_fail_htlcs.is_empty());
839         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
840         assert!(commitment_update.update_fee.is_none());
841         check_added_monitors!(nodes[1], 1);
842
843         // Deliver (7)
844         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
845         check_added_monitors!(nodes[0], 1);
846         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
847         // No commitment_signed so get_event_msg's assert(len == 1) passes
848
849         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
850         check_added_monitors!(nodes[1], 1);
851         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
852
853         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
854         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
855         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
856         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
857         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
858 }
859
860 #[test]
861 fn fake_network_test() {
862         // Simple test which builds a network of ChannelManagers, connects them to each other, and
863         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
864         let chanmon_cfgs = create_chanmon_cfgs(4);
865         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
866         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
867         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
868
869         // Create some initial channels
870         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
871         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
872         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
873
874         // Rebalance the network a bit by relaying one payment through all the channels...
875         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
876         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
877         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
878         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
879
880         // Send some more payments
881         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
882         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
883         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
884
885         // Test failure packets
886         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
887         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
888
889         // Add a new channel that skips 3
890         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
891
892         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
893         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
894         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
895         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
896         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
897         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
898         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
899
900         // Do some rebalance loop payments, simultaneously
901         let mut hops = Vec::with_capacity(3);
902         hops.push(RouteHop {
903                 pubkey: nodes[2].node.get_our_node_id(),
904                 node_features: NodeFeatures::empty(),
905                 short_channel_id: chan_2.0.contents.short_channel_id,
906                 channel_features: ChannelFeatures::empty(),
907                 fee_msat: 0,
908                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
909         });
910         hops.push(RouteHop {
911                 pubkey: nodes[3].node.get_our_node_id(),
912                 node_features: NodeFeatures::empty(),
913                 short_channel_id: chan_3.0.contents.short_channel_id,
914                 channel_features: ChannelFeatures::empty(),
915                 fee_msat: 0,
916                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
917         });
918         hops.push(RouteHop {
919                 pubkey: nodes[1].node.get_our_node_id(),
920                 node_features: NodeFeatures::known(),
921                 short_channel_id: chan_4.0.contents.short_channel_id,
922                 channel_features: ChannelFeatures::known(),
923                 fee_msat: 1000000,
924                 cltv_expiry_delta: TEST_FINAL_CLTV,
925         });
926         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;
927         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;
928         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
929
930         let mut hops = Vec::with_capacity(3);
931         hops.push(RouteHop {
932                 pubkey: nodes[3].node.get_our_node_id(),
933                 node_features: NodeFeatures::empty(),
934                 short_channel_id: chan_4.0.contents.short_channel_id,
935                 channel_features: ChannelFeatures::empty(),
936                 fee_msat: 0,
937                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
938         });
939         hops.push(RouteHop {
940                 pubkey: nodes[2].node.get_our_node_id(),
941                 node_features: NodeFeatures::empty(),
942                 short_channel_id: chan_3.0.contents.short_channel_id,
943                 channel_features: ChannelFeatures::empty(),
944                 fee_msat: 0,
945                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
946         });
947         hops.push(RouteHop {
948                 pubkey: nodes[1].node.get_our_node_id(),
949                 node_features: NodeFeatures::known(),
950                 short_channel_id: chan_2.0.contents.short_channel_id,
951                 channel_features: ChannelFeatures::known(),
952                 fee_msat: 1000000,
953                 cltv_expiry_delta: TEST_FINAL_CLTV,
954         });
955         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;
956         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;
957         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
958
959         // Claim the rebalances...
960         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
961         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
962
963         // Add a duplicate new channel from 2 to 4
964         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
965
966         // Send some payments across both channels
967         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
968         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
969         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
970
971
972         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
973         let events = nodes[0].node.get_and_clear_pending_msg_events();
974         assert_eq!(events.len(), 0);
975         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);
976
977         //TODO: Test that routes work again here as we've been notified that the channel is full
978
979         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
980         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
981         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
982
983         // Close down the channels...
984         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
985         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
986         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
987         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
988         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
989         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
990         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
991         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
992         check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
993         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
994         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
995         check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
996         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
997         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
998         check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
999 }
1000
1001 #[test]
1002 fn holding_cell_htlc_counting() {
1003         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1004         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1005         // commitment dance rounds.
1006         let chanmon_cfgs = create_chanmon_cfgs(3);
1007         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1008         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1009         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1010         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1011         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1012         let logger = test_utils::TestLogger::new();
1013
1014         let mut payments = Vec::new();
1015         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1016                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1017                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1018                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1019                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1020                 payments.push((payment_preimage, payment_hash));
1021         }
1022         check_added_monitors!(nodes[1], 1);
1023
1024         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1025         assert_eq!(events.len(), 1);
1026         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1027         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1028
1029         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1030         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1031         // another HTLC.
1032         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1033         {
1034                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1035                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1036                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1037                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1038                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1039                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1040         }
1041
1042         // This should also be true if we try to forward a payment.
1043         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1044         {
1045                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1046                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1047                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1048                 check_added_monitors!(nodes[0], 1);
1049         }
1050
1051         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1052         assert_eq!(events.len(), 1);
1053         let payment_event = SendEvent::from_event(events.pop().unwrap());
1054         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1055
1056         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1057         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1058         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1059         // fails), the second will process the resulting failure and fail the HTLC backward.
1060         expect_pending_htlcs_forwardable!(nodes[1]);
1061         expect_pending_htlcs_forwardable!(nodes[1]);
1062         check_added_monitors!(nodes[1], 1);
1063
1064         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1065         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1066         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1067
1068         expect_payment_failed_with_update!(nodes[0], payment_hash_2, false, chan_2.0.contents.short_channel_id, false);
1069
1070         // Now forward all the pending HTLCs and claim them back
1071         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1072         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1073         check_added_monitors!(nodes[2], 1);
1074
1075         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1076         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1077         check_added_monitors!(nodes[1], 1);
1078         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1079
1080         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1081         check_added_monitors!(nodes[1], 1);
1082         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1083
1084         for ref update in as_updates.update_add_htlcs.iter() {
1085                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1086         }
1087         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1088         check_added_monitors!(nodes[2], 1);
1089         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1090         check_added_monitors!(nodes[2], 1);
1091         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1092
1093         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1094         check_added_monitors!(nodes[1], 1);
1095         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1096         check_added_monitors!(nodes[1], 1);
1097         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1098
1099         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1100         check_added_monitors!(nodes[2], 1);
1101
1102         expect_pending_htlcs_forwardable!(nodes[2]);
1103
1104         let events = nodes[2].node.get_and_clear_pending_events();
1105         assert_eq!(events.len(), payments.len());
1106         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1107                 match event {
1108                         &Event::PaymentReceived { ref payment_hash, .. } => {
1109                                 assert_eq!(*payment_hash, *hash);
1110                         },
1111                         _ => panic!("Unexpected event"),
1112                 };
1113         }
1114
1115         for (preimage, _) in payments.drain(..) {
1116                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1117         }
1118
1119         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1120 }
1121
1122 #[test]
1123 fn duplicate_htlc_test() {
1124         // Test that we accept duplicate payment_hash HTLCs across the network and that
1125         // claiming/failing them are all separate and don't affect each other
1126         let chanmon_cfgs = create_chanmon_cfgs(6);
1127         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1128         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1129         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1130
1131         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1132         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1133         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1134         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1135         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1136         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1137
1138         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1139
1140         *nodes[0].network_payment_count.borrow_mut() -= 1;
1141         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1142
1143         *nodes[0].network_payment_count.borrow_mut() -= 1;
1144         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1145
1146         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1147         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1148         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1149 }
1150
1151 #[test]
1152 fn test_duplicate_htlc_different_direction_onchain() {
1153         // Test that ChannelMonitor doesn't generate 2 preimage txn
1154         // when we have 2 HTLCs with same preimage that go across a node
1155         // in opposite directions, even with the same payment secret.
1156         let chanmon_cfgs = create_chanmon_cfgs(2);
1157         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1158         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1159         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1160
1161         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1162         let logger = test_utils::TestLogger::new();
1163
1164         // balancing
1165         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1166
1167         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1168
1169         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1170         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1171         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1172         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1173
1174         // Provide preimage to node 0 by claiming payment
1175         nodes[0].node.claim_funds(payment_preimage);
1176         check_added_monitors!(nodes[0], 1);
1177
1178         // Broadcast node 1 commitment txn
1179         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1180
1181         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1182         let mut has_both_htlcs = 0; // check htlcs match ones committed
1183         for outp in remote_txn[0].output.iter() {
1184                 if outp.value == 800_000 / 1000 {
1185                         has_both_htlcs += 1;
1186                 } else if outp.value == 900_000 / 1000 {
1187                         has_both_htlcs += 1;
1188                 }
1189         }
1190         assert_eq!(has_both_htlcs, 2);
1191
1192         mine_transaction(&nodes[0], &remote_txn[0]);
1193         check_added_monitors!(nodes[0], 1);
1194         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
1195         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1196
1197         // Check we only broadcast 1 timeout tx
1198         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1199         assert_eq!(claim_txn.len(), 8);
1200         assert_eq!(claim_txn[1], claim_txn[4]);
1201         assert_eq!(claim_txn[2], claim_txn[5]);
1202         check_spends!(claim_txn[1], chan_1.3);
1203         check_spends!(claim_txn[2], claim_txn[1]);
1204         check_spends!(claim_txn[7], claim_txn[1]);
1205
1206         assert_eq!(claim_txn[0].input.len(), 1);
1207         assert_eq!(claim_txn[3].input.len(), 1);
1208         assert_eq!(claim_txn[0].input[0].previous_output, claim_txn[3].input[0].previous_output);
1209
1210         assert_eq!(claim_txn[0].input.len(), 1);
1211         assert_eq!(claim_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1212         check_spends!(claim_txn[0], remote_txn[0]);
1213         assert_eq!(remote_txn[0].output[claim_txn[0].input[0].previous_output.vout as usize].value, 800);
1214         assert_eq!(claim_txn[6].input.len(), 1);
1215         assert_eq!(claim_txn[6].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1216         check_spends!(claim_txn[6], remote_txn[0]);
1217         assert_eq!(remote_txn[0].output[claim_txn[6].input[0].previous_output.vout as usize].value, 900);
1218
1219         let events = nodes[0].node.get_and_clear_pending_msg_events();
1220         assert_eq!(events.len(), 3);
1221         for e in events {
1222                 match e {
1223                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1224                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1225                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1226                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1227                         },
1228                         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, .. } } => {
1229                                 assert!(update_add_htlcs.is_empty());
1230                                 assert!(update_fail_htlcs.is_empty());
1231                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1232                                 assert!(update_fail_malformed_htlcs.is_empty());
1233                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1234                         },
1235                         _ => panic!("Unexpected event"),
1236                 }
1237         }
1238 }
1239
1240 #[test]
1241 fn test_basic_channel_reserve() {
1242         let chanmon_cfgs = create_chanmon_cfgs(2);
1243         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1244         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1245         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1246         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1247         let logger = test_utils::TestLogger::new();
1248
1249         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1250         let channel_reserve = chan_stat.channel_reserve_msat;
1251
1252         // The 2* and +1 are for the fee spike reserve.
1253         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1254         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1255         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1256         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1257         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1258         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1259         match err {
1260                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1261                         match &fails[0] {
1262                                 &APIError::ChannelUnavailable{ref err} =>
1263                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1264                                 _ => panic!("Unexpected error variant"),
1265                         }
1266                 },
1267                 _ => panic!("Unexpected error variant"),
1268         }
1269         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1270         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);
1271
1272         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1273 }
1274
1275 #[test]
1276 fn test_fee_spike_violation_fails_htlc() {
1277         let chanmon_cfgs = create_chanmon_cfgs(2);
1278         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1279         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1280         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1281         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1282
1283         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1284         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1285         let secp_ctx = Secp256k1::new();
1286         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1287
1288         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1289
1290         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1291         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1292         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1293         let msg = msgs::UpdateAddHTLC {
1294                 channel_id: chan.2,
1295                 htlc_id: 0,
1296                 amount_msat: htlc_msat,
1297                 payment_hash: payment_hash,
1298                 cltv_expiry: htlc_cltv,
1299                 onion_routing_packet: onion_packet,
1300         };
1301
1302         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1303
1304         // Now manually create the commitment_signed message corresponding to the update_add
1305         // nodes[0] just sent. In the code for construction of this message, "local" refers
1306         // to the sender of the message, and "remote" refers to the receiver.
1307
1308         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1309
1310         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1311
1312         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1313         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1314         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point, local_funding) = {
1315                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1316                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1317                 let chan_signer = local_chan.get_signer();
1318                 // Make the signer believe we validated another commitment, so we can release the secret
1319                 chan_signer.get_enforcement_state().last_holder_commitment -= 1;
1320
1321                 let pubkeys = chan_signer.pubkeys();
1322                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1323                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1324                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx),
1325                  chan_signer.pubkeys().funding_pubkey)
1326         };
1327         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_point, remote_funding) = {
1328                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1329                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1330                 let chan_signer = remote_chan.get_signer();
1331                 let pubkeys = chan_signer.pubkeys();
1332                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1333                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
1334                  chan_signer.pubkeys().funding_pubkey)
1335         };
1336
1337         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1338         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1339                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1340
1341         // Build the remote commitment transaction so we can sign it, and then later use the
1342         // signature for the commitment_signed message.
1343         let local_chan_balance = 1313;
1344
1345         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1346                 offered: false,
1347                 amount_msat: 3460001,
1348                 cltv_expiry: htlc_cltv,
1349                 payment_hash,
1350                 transaction_output_index: Some(1),
1351         };
1352
1353         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1354
1355         let res = {
1356                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1357                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1358                 let local_chan_signer = local_chan.get_signer();
1359                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1360                         commitment_number,
1361                         95000,
1362                         local_chan_balance,
1363                         false, local_funding, remote_funding,
1364                         commit_tx_keys.clone(),
1365                         feerate_per_kw,
1366                         &mut vec![(accepted_htlc_info, ())],
1367                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1368                 );
1369                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1370         };
1371
1372         let commit_signed_msg = msgs::CommitmentSigned {
1373                 channel_id: chan.2,
1374                 signature: res.0,
1375                 htlc_signatures: res.1
1376         };
1377
1378         // Send the commitment_signed message to the nodes[1].
1379         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1380         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1381
1382         // Send the RAA to nodes[1].
1383         let raa_msg = msgs::RevokeAndACK {
1384                 channel_id: chan.2,
1385                 per_commitment_secret: local_secret,
1386                 next_per_commitment_point: next_local_point
1387         };
1388         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1389
1390         let events = nodes[1].node.get_and_clear_pending_msg_events();
1391         assert_eq!(events.len(), 1);
1392         // Make sure the HTLC failed in the way we expect.
1393         match events[0] {
1394                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1395                         assert_eq!(update_fail_htlcs.len(), 1);
1396                         update_fail_htlcs[0].clone()
1397                 },
1398                 _ => panic!("Unexpected event"),
1399         };
1400         nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1401                 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1402
1403         check_added_monitors!(nodes[1], 2);
1404 }
1405
1406 #[test]
1407 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1408         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1409         // Set the fee rate for the channel very high, to the point where the fundee
1410         // sending any above-dust amount would result in a channel reserve violation.
1411         // In this test we check that we would be prevented from sending an HTLC in
1412         // this situation.
1413         let feerate_per_kw = 253;
1414         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1415         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1416         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1417         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1418         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1419
1420         let mut push_amt = 100_000_000;
1421         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
1422         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1423
1424         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, InitFeatures::known(), InitFeatures::known());
1425
1426         // Sending exactly enough to hit the reserve amount should be accepted
1427         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1428
1429         // However one more HTLC should be significantly over the reserve amount and fail.
1430         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1431         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1432                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1433         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1434         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);
1435 }
1436
1437 #[test]
1438 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1439         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1440         // Set the fee rate for the channel very high, to the point where the funder
1441         // receiving 1 update_add_htlc would result in them closing the channel due
1442         // to channel reserve violation. This close could also happen if the fee went
1443         // up a more realistic amount, but many HTLCs were outstanding at the time of
1444         // the update_add_htlc.
1445         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1446         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(6000) };
1447         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1448         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1449         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1450         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1451
1452         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1453         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1454         let secp_ctx = Secp256k1::new();
1455         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1456         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1457         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1458         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height, &None).unwrap();
1459         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1460         let msg = msgs::UpdateAddHTLC {
1461                 channel_id: chan.2,
1462                 htlc_id: 1,
1463                 amount_msat: htlc_msat + 1,
1464                 payment_hash: payment_hash,
1465                 cltv_expiry: htlc_cltv,
1466                 onion_routing_packet: onion_packet,
1467         };
1468
1469         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1470         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1471         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);
1472         assert_eq!(nodes[0].node.list_channels().len(), 0);
1473         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1474         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1475         check_added_monitors!(nodes[0], 1);
1476         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_string() });
1477 }
1478
1479 #[test]
1480 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1481         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1482         // calculating our commitment transaction fee (this was previously broken).
1483         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1484         let feerate_per_kw = 253;
1485         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1486         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(feerate_per_kw) };
1487
1488         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1489         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1490         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1491
1492         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1493         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1494         // transaction fee with 0 HTLCs (183 sats)).
1495         let mut push_amt = 100_000_000;
1496         push_amt -= feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT) / 1000 * 1000;
1497         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000) * 1000;
1498         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, InitFeatures::known(), InitFeatures::known());
1499
1500         let dust_amt = crate::ln::channel::MIN_CHAN_DUST_LIMIT_SATOSHIS * 1000
1501                 + feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000 * 1000 - 1;
1502         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1503         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1504         // commitment transaction fee.
1505         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1506
1507         // One more than the dust amt should fail, however.
1508         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1509         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1510                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1511 }
1512
1513 #[test]
1514 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1515         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1516         // calculating our counterparty's commitment transaction fee (this was previously broken).
1517         let chanmon_cfgs = create_chanmon_cfgs(2);
1518         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1519         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1520         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1521         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1522
1523         let payment_amt = 46000; // Dust amount
1524         // In the previous code, these first four payments would succeed.
1525         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1526         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1527         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1528         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1529
1530         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1531         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1532         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1533         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1534         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1535         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1536
1537         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1538         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1539         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1540         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1541 }
1542
1543 #[test]
1544 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1545         let chanmon_cfgs = create_chanmon_cfgs(3);
1546         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1547         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1548         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1549         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1550         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1551
1552         let feemsat = 239;
1553         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1554         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1555         let feerate = get_feerate!(nodes[0], chan.2);
1556
1557         // Add a 2* and +1 for the fee spike reserve.
1558         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1559         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;
1560         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1561
1562         // Add a pending HTLC.
1563         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1564         let payment_event_1 = {
1565                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1566                 check_added_monitors!(nodes[0], 1);
1567
1568                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1569                 assert_eq!(events.len(), 1);
1570                 SendEvent::from_event(events.remove(0))
1571         };
1572         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1573
1574         // Attempt to trigger a channel reserve violation --> payment failure.
1575         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1576         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;
1577         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1578         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1579
1580         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1581         let secp_ctx = Secp256k1::new();
1582         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1583         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1584         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1585         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1586         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1587         let msg = msgs::UpdateAddHTLC {
1588                 channel_id: chan.2,
1589                 htlc_id: 1,
1590                 amount_msat: htlc_msat + 1,
1591                 payment_hash: our_payment_hash_1,
1592                 cltv_expiry: htlc_cltv,
1593                 onion_routing_packet: onion_packet,
1594         };
1595
1596         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1597         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1598         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1599         assert_eq!(nodes[1].node.list_channels().len(), 1);
1600         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1601         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1602         check_added_monitors!(nodes[1], 1);
1603         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote HTLC add would put them under remote reserve value".to_string() });
1604 }
1605
1606 #[test]
1607 fn test_inbound_outbound_capacity_is_not_zero() {
1608         let chanmon_cfgs = create_chanmon_cfgs(2);
1609         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1610         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1611         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1612         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1613         let channels0 = node_chanmgrs[0].list_channels();
1614         let channels1 = node_chanmgrs[1].list_channels();
1615         assert_eq!(channels0.len(), 1);
1616         assert_eq!(channels1.len(), 1);
1617
1618         let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100000);
1619         assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1620         assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1621
1622         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1623         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1624 }
1625
1626 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1627         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1628 }
1629
1630 #[test]
1631 fn test_channel_reserve_holding_cell_htlcs() {
1632         let chanmon_cfgs = create_chanmon_cfgs(3);
1633         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1634         // When this test was written, the default base fee floated based on the HTLC count.
1635         // It is now fixed, so we simply set the fee to the expected value here.
1636         let mut config = test_default_channel_config();
1637         config.channel_options.forwarding_fee_base_msat = 239;
1638         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1639         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1640         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1641         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1642
1643         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1644         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1645
1646         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1647         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1648
1649         macro_rules! expect_forward {
1650                 ($node: expr) => {{
1651                         let mut events = $node.node.get_and_clear_pending_msg_events();
1652                         assert_eq!(events.len(), 1);
1653                         check_added_monitors!($node, 1);
1654                         let payment_event = SendEvent::from_event(events.remove(0));
1655                         payment_event
1656                 }}
1657         }
1658
1659         let feemsat = 239; // set above
1660         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1661         let feerate = get_feerate!(nodes[0], chan_1.2);
1662
1663         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1664
1665         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1666         {
1667                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1668                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1669                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1670                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1671                         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)));
1672                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1673                 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);
1674         }
1675
1676         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1677         // nodes[0]'s wealth
1678         loop {
1679                 let amt_msat = recv_value_0 + total_fee_msat;
1680                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1681                 // Also, ensure that each payment has enough to be over the dust limit to
1682                 // ensure it'll be included in each commit tx fee calculation.
1683                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1684                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1685                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1686                         break;
1687                 }
1688                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1689
1690                 let (stat01_, stat11_, stat12_, stat22_) = (
1691                         get_channel_value_stat!(nodes[0], chan_1.2),
1692                         get_channel_value_stat!(nodes[1], chan_1.2),
1693                         get_channel_value_stat!(nodes[1], chan_2.2),
1694                         get_channel_value_stat!(nodes[2], chan_2.2),
1695                 );
1696
1697                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1698                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1699                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1700                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1701                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1702         }
1703
1704         // adding pending output.
1705         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1706         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1707         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1708         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1709         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1710         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1711         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1712         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1713         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1714         // policy.
1715         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1716         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1717         let amt_msat_1 = recv_value_1 + total_fee_msat;
1718
1719         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);
1720         let payment_event_1 = {
1721                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1722                 check_added_monitors!(nodes[0], 1);
1723
1724                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1725                 assert_eq!(events.len(), 1);
1726                 SendEvent::from_event(events.remove(0))
1727         };
1728         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1729
1730         // channel reserve test with htlc pending output > 0
1731         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1732         {
1733                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1734                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1735                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1736                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1737         }
1738
1739         // split the rest to test holding cell
1740         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1741         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1742         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1743         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1744         {
1745                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1746                 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);
1747         }
1748
1749         // now see if they go through on both sides
1750         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);
1751         // but this will stuck in the holding cell
1752         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
1753         check_added_monitors!(nodes[0], 0);
1754         let events = nodes[0].node.get_and_clear_pending_events();
1755         assert_eq!(events.len(), 0);
1756
1757         // test with outbound holding cell amount > 0
1758         {
1759                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
1760                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1761                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1762                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1763                 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);
1764         }
1765
1766         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);
1767         // this will also stuck in the holding cell
1768         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
1769         check_added_monitors!(nodes[0], 0);
1770         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1771         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1772
1773         // flush the pending htlc
1774         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1775         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1776         check_added_monitors!(nodes[1], 1);
1777
1778         // the pending htlc should be promoted to committed
1779         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1780         check_added_monitors!(nodes[0], 1);
1781         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1782
1783         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1784         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1785         // No commitment_signed so get_event_msg's assert(len == 1) passes
1786         check_added_monitors!(nodes[0], 1);
1787
1788         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1789         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1790         check_added_monitors!(nodes[1], 1);
1791
1792         expect_pending_htlcs_forwardable!(nodes[1]);
1793
1794         let ref payment_event_11 = expect_forward!(nodes[1]);
1795         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1796         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1797
1798         expect_pending_htlcs_forwardable!(nodes[2]);
1799         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
1800
1801         // flush the htlcs in the holding cell
1802         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1803         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1804         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1805         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1806         expect_pending_htlcs_forwardable!(nodes[1]);
1807
1808         let ref payment_event_3 = expect_forward!(nodes[1]);
1809         assert_eq!(payment_event_3.msgs.len(), 2);
1810         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1811         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1812
1813         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1814         expect_pending_htlcs_forwardable!(nodes[2]);
1815
1816         let events = nodes[2].node.get_and_clear_pending_events();
1817         assert_eq!(events.len(), 2);
1818         match events[0] {
1819                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1820                         assert_eq!(our_payment_hash_21, *payment_hash);
1821                         assert_eq!(recv_value_21, amt);
1822                         match &purpose {
1823                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1824                                         assert!(payment_preimage.is_none());
1825                                         assert_eq!(our_payment_secret_21, *payment_secret);
1826                                 },
1827                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
1828                         }
1829                 },
1830                 _ => panic!("Unexpected event"),
1831         }
1832         match events[1] {
1833                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1834                         assert_eq!(our_payment_hash_22, *payment_hash);
1835                         assert_eq!(recv_value_22, amt);
1836                         match &purpose {
1837                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1838                                         assert!(payment_preimage.is_none());
1839                                         assert_eq!(our_payment_secret_22, *payment_secret);
1840                                 },
1841                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
1842                         }
1843                 },
1844                 _ => panic!("Unexpected event"),
1845         }
1846
1847         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
1848         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
1849         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
1850
1851         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
1852         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
1853         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
1854
1855         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
1856         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);
1857         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1858         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1859         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
1860
1861         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1862         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
1863 }
1864
1865 #[test]
1866 fn channel_reserve_in_flight_removes() {
1867         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1868         // can send to its counterparty, but due to update ordering, the other side may not yet have
1869         // considered those HTLCs fully removed.
1870         // This tests that we don't count HTLCs which will not be included in the next remote
1871         // commitment transaction towards the reserve value (as it implies no commitment transaction
1872         // will be generated which violates the remote reserve value).
1873         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1874         // To test this we:
1875         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1876         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1877         //    you only consider the value of the first HTLC, it may not),
1878         //  * start routing a third HTLC from A to B,
1879         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1880         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1881         //  * deliver the first fulfill from B
1882         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1883         //    claim,
1884         //  * deliver A's response CS and RAA.
1885         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1886         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1887         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1888         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1889         let chanmon_cfgs = create_chanmon_cfgs(2);
1890         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1891         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1892         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1893         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1894         let logger = test_utils::TestLogger::new();
1895
1896         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1897         // Route the first two HTLCs.
1898         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1899         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1900
1901         // Start routing the third HTLC (this is just used to get everyone in the right state).
1902         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
1903         let send_1 = {
1904                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1905                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
1906                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
1907                 check_added_monitors!(nodes[0], 1);
1908                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1909                 assert_eq!(events.len(), 1);
1910                 SendEvent::from_event(events.remove(0))
1911         };
1912
1913         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1914         // initial fulfill/CS.
1915         assert!(nodes[1].node.claim_funds(payment_preimage_1));
1916         check_added_monitors!(nodes[1], 1);
1917         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1918
1919         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1920         // remove the second HTLC when we send the HTLC back from B to A.
1921         assert!(nodes[1].node.claim_funds(payment_preimage_2));
1922         check_added_monitors!(nodes[1], 1);
1923         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1924
1925         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1926         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1927         check_added_monitors!(nodes[0], 1);
1928         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1929         expect_payment_sent!(nodes[0], payment_preimage_1);
1930
1931         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1932         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1933         check_added_monitors!(nodes[1], 1);
1934         // B is already AwaitingRAA, so cant generate a CS here
1935         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1936
1937         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1938         check_added_monitors!(nodes[1], 1);
1939         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1940
1941         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1942         check_added_monitors!(nodes[0], 1);
1943         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1944
1945         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1946         check_added_monitors!(nodes[1], 1);
1947         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1948
1949         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1950         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1951         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1952         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1953         // on-chain as necessary).
1954         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1955         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1956         check_added_monitors!(nodes[0], 1);
1957         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1958         expect_payment_sent!(nodes[0], payment_preimage_2);
1959
1960         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1961         check_added_monitors!(nodes[1], 1);
1962         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1963
1964         expect_pending_htlcs_forwardable!(nodes[1]);
1965         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
1966
1967         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1968         // resolve the second HTLC from A's point of view.
1969         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1970         check_added_monitors!(nodes[0], 1);
1971         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1972
1973         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1974         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1975         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
1976         let send_2 = {
1977                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1978                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
1979                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
1980                 check_added_monitors!(nodes[1], 1);
1981                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1982                 assert_eq!(events.len(), 1);
1983                 SendEvent::from_event(events.remove(0))
1984         };
1985
1986         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1987         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1988         check_added_monitors!(nodes[0], 1);
1989         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1990
1991         // Now just resolve all the outstanding messages/HTLCs for completeness...
1992
1993         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1994         check_added_monitors!(nodes[1], 1);
1995         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1996
1997         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1998         check_added_monitors!(nodes[1], 1);
1999
2000         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2001         check_added_monitors!(nodes[0], 1);
2002         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2003
2004         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2005         check_added_monitors!(nodes[1], 1);
2006         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2007
2008         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2009         check_added_monitors!(nodes[0], 1);
2010
2011         expect_pending_htlcs_forwardable!(nodes[0]);
2012         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2013
2014         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2015         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2016 }
2017
2018 #[test]
2019 fn channel_monitor_network_test() {
2020         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2021         // tests that ChannelMonitor is able to recover from various states.
2022         let chanmon_cfgs = create_chanmon_cfgs(5);
2023         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2024         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2025         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2026
2027         // Create some initial channels
2028         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2029         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2030         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2031         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2032
2033         // Make sure all nodes are at the same starting height
2034         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2035         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2036         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2037         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2038         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2039
2040         // Rebalance the network a bit by relaying one payment through all the channels...
2041         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2042         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2043         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2044         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2045
2046         // Simple case with no pending HTLCs:
2047         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2048         check_added_monitors!(nodes[1], 1);
2049         check_closed_broadcast!(nodes[1], false);
2050         {
2051                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2052                 assert_eq!(node_txn.len(), 1);
2053                 mine_transaction(&nodes[0], &node_txn[0]);
2054                 check_added_monitors!(nodes[0], 1);
2055                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2056         }
2057         check_closed_broadcast!(nodes[0], true);
2058         assert_eq!(nodes[0].node.list_channels().len(), 0);
2059         assert_eq!(nodes[1].node.list_channels().len(), 1);
2060         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2061         check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
2062
2063         // One pending HTLC is discarded by the force-close:
2064         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2065
2066         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2067         // broadcasted until we reach the timelock time).
2068         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2069         check_closed_broadcast!(nodes[1], false);
2070         check_added_monitors!(nodes[1], 1);
2071         {
2072                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2073                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2074                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2075                 mine_transaction(&nodes[2], &node_txn[0]);
2076                 check_added_monitors!(nodes[2], 1);
2077                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2078         }
2079         check_closed_broadcast!(nodes[2], true);
2080         assert_eq!(nodes[1].node.list_channels().len(), 0);
2081         assert_eq!(nodes[2].node.list_channels().len(), 1);
2082         check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
2083         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2084
2085         macro_rules! claim_funds {
2086                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2087                         {
2088                                 assert!($node.node.claim_funds($preimage));
2089                                 check_added_monitors!($node, 1);
2090
2091                                 let events = $node.node.get_and_clear_pending_msg_events();
2092                                 assert_eq!(events.len(), 1);
2093                                 match events[0] {
2094                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2095                                                 assert!(update_add_htlcs.is_empty());
2096                                                 assert!(update_fail_htlcs.is_empty());
2097                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2098                                         },
2099                                         _ => panic!("Unexpected event"),
2100                                 };
2101                         }
2102                 }
2103         }
2104
2105         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2106         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2107         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2108         check_added_monitors!(nodes[2], 1);
2109         check_closed_broadcast!(nodes[2], false);
2110         let node2_commitment_txid;
2111         {
2112                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2113                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2114                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2115                 node2_commitment_txid = node_txn[0].txid();
2116
2117                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2118                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2119                 mine_transaction(&nodes[3], &node_txn[0]);
2120                 check_added_monitors!(nodes[3], 1);
2121                 check_preimage_claim(&nodes[3], &node_txn);
2122         }
2123         check_closed_broadcast!(nodes[3], true);
2124         assert_eq!(nodes[2].node.list_channels().len(), 0);
2125         assert_eq!(nodes[3].node.list_channels().len(), 1);
2126         check_closed_event!(nodes[2], 1, ClosureReason::DisconnectedPeer);
2127         check_closed_event!(nodes[3], 1, ClosureReason::CommitmentTxConfirmed);
2128
2129         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2130         // confusing us in the following tests.
2131         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2132
2133         // One pending HTLC to time out:
2134         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2135         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2136         // buffer space).
2137
2138         let (close_chan_update_1, close_chan_update_2) = {
2139                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2140                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2141                 assert_eq!(events.len(), 2);
2142                 let close_chan_update_1 = match events[0] {
2143                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2144                                 msg.clone()
2145                         },
2146                         _ => panic!("Unexpected event"),
2147                 };
2148                 match events[1] {
2149                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2150                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2151                         },
2152                         _ => panic!("Unexpected event"),
2153                 }
2154                 check_added_monitors!(nodes[3], 1);
2155
2156                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2157                 {
2158                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2159                         node_txn.retain(|tx| {
2160                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2161                                         false
2162                                 } else { true }
2163                         });
2164                 }
2165
2166                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2167
2168                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2169                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2170
2171                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2172                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2173                 assert_eq!(events.len(), 2);
2174                 let close_chan_update_2 = match events[0] {
2175                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2176                                 msg.clone()
2177                         },
2178                         _ => panic!("Unexpected event"),
2179                 };
2180                 match events[1] {
2181                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2182                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2183                         },
2184                         _ => panic!("Unexpected event"),
2185                 }
2186                 check_added_monitors!(nodes[4], 1);
2187                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2188
2189                 mine_transaction(&nodes[4], &node_txn[0]);
2190                 check_preimage_claim(&nodes[4], &node_txn);
2191                 (close_chan_update_1, close_chan_update_2)
2192         };
2193         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2194         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2195         assert_eq!(nodes[3].node.list_channels().len(), 0);
2196         assert_eq!(nodes[4].node.list_channels().len(), 0);
2197
2198         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2199         check_closed_event!(nodes[3], 1, ClosureReason::CommitmentTxConfirmed);
2200         check_closed_event!(nodes[4], 1, ClosureReason::CommitmentTxConfirmed);
2201 }
2202
2203 #[test]
2204 fn test_justice_tx() {
2205         // Test justice txn built on revoked HTLC-Success tx, against both sides
2206         let mut alice_config = UserConfig::default();
2207         alice_config.channel_options.announced_channel = true;
2208         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2209         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2210         let mut bob_config = UserConfig::default();
2211         bob_config.channel_options.announced_channel = true;
2212         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2213         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2214         let user_cfgs = [Some(alice_config), Some(bob_config)];
2215         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2216         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2217         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2218         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2219         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2220         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2221         // Create some new channels:
2222         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2223
2224         // A pending HTLC which will be revoked:
2225         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2226         // Get the will-be-revoked local txn from nodes[0]
2227         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2228         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2229         assert_eq!(revoked_local_txn[0].input.len(), 1);
2230         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2231         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2232         assert_eq!(revoked_local_txn[1].input.len(), 1);
2233         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2234         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2235         // Revoke the old state
2236         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2237
2238         {
2239                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2240                 {
2241                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2242                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2243                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2244
2245                         check_spends!(node_txn[0], revoked_local_txn[0]);
2246                         node_txn.swap_remove(0);
2247                         node_txn.truncate(1);
2248                 }
2249                 check_added_monitors!(nodes[1], 1);
2250                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2251                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2252
2253                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2254                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2255                 // Verify broadcast of revoked HTLC-timeout
2256                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2257                 check_added_monitors!(nodes[0], 1);
2258                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2259                 // Broadcast revoked HTLC-timeout on node 1
2260                 mine_transaction(&nodes[1], &node_txn[1]);
2261                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2262         }
2263         get_announce_close_broadcast_events(&nodes, 0, 1);
2264
2265         assert_eq!(nodes[0].node.list_channels().len(), 0);
2266         assert_eq!(nodes[1].node.list_channels().len(), 0);
2267
2268         // We test justice_tx build by A on B's revoked HTLC-Success tx
2269         // Create some new channels:
2270         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2271         {
2272                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2273                 node_txn.clear();
2274         }
2275
2276         // A pending HTLC which will be revoked:
2277         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2278         // Get the will-be-revoked local txn from B
2279         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2280         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2281         assert_eq!(revoked_local_txn[0].input.len(), 1);
2282         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2283         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2284         // Revoke the old state
2285         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2286         {
2287                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2288                 {
2289                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2290                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2291                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2292
2293                         check_spends!(node_txn[0], revoked_local_txn[0]);
2294                         node_txn.swap_remove(0);
2295                 }
2296                 check_added_monitors!(nodes[0], 1);
2297                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2298
2299                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2300                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2301                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2302                 check_added_monitors!(nodes[1], 1);
2303                 mine_transaction(&nodes[0], &node_txn[1]);
2304                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2305                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2306         }
2307         get_announce_close_broadcast_events(&nodes, 0, 1);
2308         assert_eq!(nodes[0].node.list_channels().len(), 0);
2309         assert_eq!(nodes[1].node.list_channels().len(), 0);
2310 }
2311
2312 #[test]
2313 fn revoked_output_claim() {
2314         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2315         // transaction is broadcast by its counterparty
2316         let chanmon_cfgs = create_chanmon_cfgs(2);
2317         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2318         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2319         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2320         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2321         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2322         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2323         assert_eq!(revoked_local_txn.len(), 1);
2324         // Only output is the full channel value back to nodes[0]:
2325         assert_eq!(revoked_local_txn[0].output.len(), 1);
2326         // Send a payment through, updating everyone's latest commitment txn
2327         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2328
2329         // Inform nodes[1] that nodes[0] broadcast a stale tx
2330         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2331         check_added_monitors!(nodes[1], 1);
2332         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2333         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2334         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2335
2336         check_spends!(node_txn[0], revoked_local_txn[0]);
2337         check_spends!(node_txn[1], chan_1.3);
2338
2339         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2340         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2341         get_announce_close_broadcast_events(&nodes, 0, 1);
2342         check_added_monitors!(nodes[0], 1);
2343         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2344 }
2345
2346 #[test]
2347 fn claim_htlc_outputs_shared_tx() {
2348         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2349         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2350         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2351         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2352         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2353         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2354
2355         // Create some new channel:
2356         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2357
2358         // Rebalance the network to generate htlc in the two directions
2359         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2360         // 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
2361         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2362         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2363
2364         // Get the will-be-revoked local txn from node[0]
2365         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2366         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2367         assert_eq!(revoked_local_txn[0].input.len(), 1);
2368         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2369         assert_eq!(revoked_local_txn[1].input.len(), 1);
2370         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2371         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2372         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2373
2374         //Revoke the old state
2375         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2376
2377         {
2378                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2379                 check_added_monitors!(nodes[0], 1);
2380                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2381                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2382                 check_added_monitors!(nodes[1], 1);
2383                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2384                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2385                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2386
2387                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2388                 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2389
2390                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2391                 check_spends!(node_txn[0], revoked_local_txn[0]);
2392
2393                 let mut witness_lens = BTreeSet::new();
2394                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2395                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2396                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2397                 assert_eq!(witness_lens.len(), 3);
2398                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2399                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2400                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2401
2402                 // Next nodes[1] broadcasts its current local tx state:
2403                 assert_eq!(node_txn[1].input.len(), 1);
2404                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2405         }
2406         get_announce_close_broadcast_events(&nodes, 0, 1);
2407         assert_eq!(nodes[0].node.list_channels().len(), 0);
2408         assert_eq!(nodes[1].node.list_channels().len(), 0);
2409 }
2410
2411 #[test]
2412 fn claim_htlc_outputs_single_tx() {
2413         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2414         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2415         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2416         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2417         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2418         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2419
2420         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2421
2422         // Rebalance the network to generate htlc in the two directions
2423         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2424         // 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
2425         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2426         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2427         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2428
2429         // Get the will-be-revoked local txn from node[0]
2430         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2431
2432         //Revoke the old state
2433         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2434
2435         {
2436                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2437                 check_added_monitors!(nodes[0], 1);
2438                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2439                 check_added_monitors!(nodes[1], 1);
2440                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2441                 let mut events = nodes[0].node.get_and_clear_pending_events();
2442                 expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
2443                 match events[1] {
2444                         Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2445                         _ => panic!("Unexpected event"),
2446                 }
2447
2448                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2449                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2450
2451                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2452                 assert_eq!(node_txn.len(), 9);
2453                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2454                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2455                 // 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)
2456                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2457
2458                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2459                 assert_eq!(node_txn[0].input.len(), 1);
2460                 check_spends!(node_txn[0], chan_1.3);
2461                 assert_eq!(node_txn[1].input.len(), 1);
2462                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2463                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2464                 check_spends!(node_txn[1], node_txn[0]);
2465
2466                 // Justice transactions are indices 1-2-4
2467                 assert_eq!(node_txn[2].input.len(), 1);
2468                 assert_eq!(node_txn[3].input.len(), 1);
2469                 assert_eq!(node_txn[4].input.len(), 1);
2470
2471                 check_spends!(node_txn[2], revoked_local_txn[0]);
2472                 check_spends!(node_txn[3], revoked_local_txn[0]);
2473                 check_spends!(node_txn[4], revoked_local_txn[0]);
2474
2475                 let mut witness_lens = BTreeSet::new();
2476                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2477                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2478                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2479                 assert_eq!(witness_lens.len(), 3);
2480                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2481                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2482                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2483         }
2484         get_announce_close_broadcast_events(&nodes, 0, 1);
2485         assert_eq!(nodes[0].node.list_channels().len(), 0);
2486         assert_eq!(nodes[1].node.list_channels().len(), 0);
2487 }
2488
2489 #[test]
2490 fn test_htlc_on_chain_success() {
2491         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2492         // the preimage backward accordingly. So here we test that ChannelManager is
2493         // broadcasting the right event to other nodes in payment path.
2494         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2495         // A --------------------> B ----------------------> C (preimage)
2496         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2497         // commitment transaction was broadcast.
2498         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2499         // towards B.
2500         // B should be able to claim via preimage if A then broadcasts its local tx.
2501         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2502         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2503         // PaymentSent event).
2504
2505         let chanmon_cfgs = create_chanmon_cfgs(3);
2506         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2507         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2508         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2509
2510         // Create some initial channels
2511         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2512         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2513
2514         // Ensure all nodes are at the same height
2515         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2516         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2517         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2518         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2519
2520         // Rebalance the network a bit by relaying one payment through all the channels...
2521         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2522         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2523
2524         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2525         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2526
2527         // Broadcast legit commitment tx from C on B's chain
2528         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2529         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2530         assert_eq!(commitment_tx.len(), 1);
2531         check_spends!(commitment_tx[0], chan_2.3);
2532         nodes[2].node.claim_funds(our_payment_preimage);
2533         nodes[2].node.claim_funds(our_payment_preimage_2);
2534         check_added_monitors!(nodes[2], 2);
2535         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2536         assert!(updates.update_add_htlcs.is_empty());
2537         assert!(updates.update_fail_htlcs.is_empty());
2538         assert!(updates.update_fail_malformed_htlcs.is_empty());
2539         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2540
2541         mine_transaction(&nodes[2], &commitment_tx[0]);
2542         check_closed_broadcast!(nodes[2], true);
2543         check_added_monitors!(nodes[2], 1);
2544         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2545         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)
2546         assert_eq!(node_txn.len(), 5);
2547         assert_eq!(node_txn[0], node_txn[3]);
2548         assert_eq!(node_txn[1], node_txn[4]);
2549         assert_eq!(node_txn[2], commitment_tx[0]);
2550         check_spends!(node_txn[0], commitment_tx[0]);
2551         check_spends!(node_txn[1], commitment_tx[0]);
2552         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2553         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2554         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2555         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2556         assert_eq!(node_txn[0].lock_time, 0);
2557         assert_eq!(node_txn[1].lock_time, 0);
2558
2559         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2560         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2561         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2562         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2563         {
2564                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2565                 assert_eq!(added_monitors.len(), 1);
2566                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2567                 added_monitors.clear();
2568         }
2569         let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2570         assert_eq!(forwarded_events.len(), 3);
2571         match forwarded_events[0] {
2572                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2573                 _ => panic!("Unexpected event"),
2574         }
2575         if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[1] {
2576                 } else { panic!(); }
2577         if let Event::PaymentForwarded { fee_earned_msat: Some(1000), claim_from_onchain_tx: true } = forwarded_events[2] {
2578                 } else { panic!(); }
2579         let events = nodes[1].node.get_and_clear_pending_msg_events();
2580         {
2581                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2582                 assert_eq!(added_monitors.len(), 2);
2583                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2584                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2585                 added_monitors.clear();
2586         }
2587         assert_eq!(events.len(), 3);
2588         match events[0] {
2589                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2590                 _ => panic!("Unexpected event"),
2591         }
2592         match events[1] {
2593                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2594                 _ => panic!("Unexpected event"),
2595         }
2596
2597         match events[2] {
2598                 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, .. } } => {
2599                         assert!(update_add_htlcs.is_empty());
2600                         assert!(update_fail_htlcs.is_empty());
2601                         assert_eq!(update_fulfill_htlcs.len(), 1);
2602                         assert!(update_fail_malformed_htlcs.is_empty());
2603                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2604                 },
2605                 _ => panic!("Unexpected event"),
2606         };
2607         macro_rules! check_tx_local_broadcast {
2608                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2609                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2610                         assert_eq!(node_txn.len(), 3);
2611                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2612                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2613                         check_spends!(node_txn[1], $commitment_tx);
2614                         check_spends!(node_txn[2], $commitment_tx);
2615                         assert_ne!(node_txn[1].lock_time, 0);
2616                         assert_ne!(node_txn[2].lock_time, 0);
2617                         if $htlc_offered {
2618                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2619                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2620                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2621                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2622                         } else {
2623                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2624                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2625                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2626                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2627                         }
2628                         check_spends!(node_txn[0], $chan_tx);
2629                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2630                         node_txn.clear();
2631                 } }
2632         }
2633         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2634         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2635         // timeout-claim of the output that nodes[2] just claimed via success.
2636         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2637
2638         // Broadcast legit commitment tx from A on B's chain
2639         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2640         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2641         check_spends!(node_a_commitment_tx[0], chan_1.3);
2642         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2643         check_closed_broadcast!(nodes[1], true);
2644         check_added_monitors!(nodes[1], 1);
2645         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2646         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2647         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2648         let commitment_spend =
2649                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2650                         check_spends!(node_txn[1], commitment_tx[0]);
2651                         check_spends!(node_txn[2], commitment_tx[0]);
2652                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2653                         &node_txn[0]
2654                 } else {
2655                         check_spends!(node_txn[0], commitment_tx[0]);
2656                         check_spends!(node_txn[1], commitment_tx[0]);
2657                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2658                         &node_txn[2]
2659                 };
2660
2661         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2662         assert_eq!(commitment_spend.input.len(), 2);
2663         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2664         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2665         assert_eq!(commitment_spend.lock_time, 0);
2666         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2667         check_spends!(node_txn[3], chan_1.3);
2668         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2669         check_spends!(node_txn[4], node_txn[3]);
2670         check_spends!(node_txn[5], node_txn[3]);
2671         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2672         // we already checked the same situation with A.
2673
2674         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2675         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2676         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2677         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2678         check_closed_broadcast!(nodes[0], true);
2679         check_added_monitors!(nodes[0], 1);
2680         let events = nodes[0].node.get_and_clear_pending_events();
2681         assert_eq!(events.len(), 3);
2682         let mut first_claimed = false;
2683         for event in events {
2684                 match event {
2685                         Event::PaymentSent { payment_preimage } => {
2686                                 if payment_preimage == our_payment_preimage {
2687                                         assert!(!first_claimed);
2688                                         first_claimed = true;
2689                                 } else {
2690                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2691                                 }
2692                         },
2693                         Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {},
2694                         _ => panic!("Unexpected event"),
2695                 }
2696         }
2697         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2698 }
2699
2700 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2701         // Test that in case of a unilateral close onchain, we detect the state of output and
2702         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2703         // broadcasting the right event to other nodes in payment path.
2704         // A ------------------> B ----------------------> C (timeout)
2705         //    B's commitment tx                 C's commitment tx
2706         //            \                                  \
2707         //         B's HTLC timeout tx               B's timeout tx
2708
2709         let chanmon_cfgs = create_chanmon_cfgs(3);
2710         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2711         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2712         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2713         *nodes[0].connect_style.borrow_mut() = connect_style;
2714         *nodes[1].connect_style.borrow_mut() = connect_style;
2715         *nodes[2].connect_style.borrow_mut() = connect_style;
2716
2717         // Create some intial channels
2718         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2719         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2720
2721         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2722         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2723         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2724
2725         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2726
2727         // Broadcast legit commitment tx from C on B's chain
2728         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2729         check_spends!(commitment_tx[0], chan_2.3);
2730         nodes[2].node.fail_htlc_backwards(&payment_hash);
2731         check_added_monitors!(nodes[2], 0);
2732         expect_pending_htlcs_forwardable!(nodes[2]);
2733         check_added_monitors!(nodes[2], 1);
2734
2735         let events = nodes[2].node.get_and_clear_pending_msg_events();
2736         assert_eq!(events.len(), 1);
2737         match events[0] {
2738                 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, .. } } => {
2739                         assert!(update_add_htlcs.is_empty());
2740                         assert!(!update_fail_htlcs.is_empty());
2741                         assert!(update_fulfill_htlcs.is_empty());
2742                         assert!(update_fail_malformed_htlcs.is_empty());
2743                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2744                 },
2745                 _ => panic!("Unexpected event"),
2746         };
2747         mine_transaction(&nodes[2], &commitment_tx[0]);
2748         check_closed_broadcast!(nodes[2], true);
2749         check_added_monitors!(nodes[2], 1);
2750         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2751         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2752         assert_eq!(node_txn.len(), 1);
2753         check_spends!(node_txn[0], chan_2.3);
2754         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2755
2756         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2757         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2758         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2759         mine_transaction(&nodes[1], &commitment_tx[0]);
2760         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2761         let timeout_tx;
2762         {
2763                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2764                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2765                 assert_eq!(node_txn[0], node_txn[3]);
2766                 assert_eq!(node_txn[1], node_txn[4]);
2767
2768                 check_spends!(node_txn[2], commitment_tx[0]);
2769                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2770
2771                 check_spends!(node_txn[0], chan_2.3);
2772                 check_spends!(node_txn[1], node_txn[0]);
2773                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2774                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2775
2776                 timeout_tx = node_txn[2].clone();
2777                 node_txn.clear();
2778         }
2779
2780         mine_transaction(&nodes[1], &timeout_tx);
2781         check_added_monitors!(nodes[1], 1);
2782         check_closed_broadcast!(nodes[1], true);
2783         {
2784                 // B will rebroadcast a fee-bumped timeout transaction here.
2785                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2786                 assert_eq!(node_txn.len(), 1);
2787                 check_spends!(node_txn[0], commitment_tx[0]);
2788         }
2789
2790         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2791         {
2792                 // B may rebroadcast its own holder commitment transaction here, as a safeguard against
2793                 // some incredibly unlikely partial-eclipse-attack scenarios. That said, because the
2794                 // original commitment_tx[0] (also spending chan_2.3) has reached ANTI_REORG_DELAY B really
2795                 // shouldn't broadcast anything here, and in some connect style scenarios we do not.
2796                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2797                 if node_txn.len() == 1 {
2798                         check_spends!(node_txn[0], chan_2.3);
2799                 } else {
2800                         assert_eq!(node_txn.len(), 0);
2801                 }
2802         }
2803
2804         expect_pending_htlcs_forwardable!(nodes[1]);
2805         check_added_monitors!(nodes[1], 1);
2806         let events = nodes[1].node.get_and_clear_pending_msg_events();
2807         assert_eq!(events.len(), 1);
2808         match events[0] {
2809                 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, .. } } => {
2810                         assert!(update_add_htlcs.is_empty());
2811                         assert!(!update_fail_htlcs.is_empty());
2812                         assert!(update_fulfill_htlcs.is_empty());
2813                         assert!(update_fail_malformed_htlcs.is_empty());
2814                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2815                 },
2816                 _ => panic!("Unexpected event"),
2817         };
2818
2819         // Broadcast legit commitment tx from B on A's chain
2820         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2821         check_spends!(commitment_tx[0], chan_1.3);
2822
2823         mine_transaction(&nodes[0], &commitment_tx[0]);
2824         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2825
2826         check_closed_broadcast!(nodes[0], true);
2827         check_added_monitors!(nodes[0], 1);
2828         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2829         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
2830         assert_eq!(node_txn.len(), 2);
2831         check_spends!(node_txn[0], chan_1.3);
2832         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2833         check_spends!(node_txn[1], commitment_tx[0]);
2834         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2835 }
2836
2837 #[test]
2838 fn test_htlc_on_chain_timeout() {
2839         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
2840         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
2841         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
2842 }
2843
2844 #[test]
2845 fn test_simple_commitment_revoked_fail_backward() {
2846         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2847         // and fail backward accordingly.
2848
2849         let chanmon_cfgs = create_chanmon_cfgs(3);
2850         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2851         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2852         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2853
2854         // Create some initial channels
2855         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2856         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2857
2858         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2859         // Get the will-be-revoked local txn from nodes[2]
2860         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2861         // Revoke the old state
2862         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2863
2864         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2865
2866         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2867         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2868         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2869         check_added_monitors!(nodes[1], 1);
2870         check_closed_broadcast!(nodes[1], true);
2871
2872         expect_pending_htlcs_forwardable!(nodes[1]);
2873         check_added_monitors!(nodes[1], 1);
2874         let events = nodes[1].node.get_and_clear_pending_msg_events();
2875         assert_eq!(events.len(), 1);
2876         match events[0] {
2877                 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, .. } } => {
2878                         assert!(update_add_htlcs.is_empty());
2879                         assert_eq!(update_fail_htlcs.len(), 1);
2880                         assert!(update_fulfill_htlcs.is_empty());
2881                         assert!(update_fail_malformed_htlcs.is_empty());
2882                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2883
2884                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2885                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2886                         expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_2.0.contents.short_channel_id, true);
2887                 },
2888                 _ => panic!("Unexpected event"),
2889         }
2890 }
2891
2892 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2893         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2894         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2895         // commitment transaction anymore.
2896         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2897         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2898         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2899         // technically disallowed and we should probably handle it reasonably.
2900         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2901         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2902         // transactions:
2903         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2904         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2905         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2906         //   and once they revoke the previous commitment transaction (allowing us to send a new
2907         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2908         let chanmon_cfgs = create_chanmon_cfgs(3);
2909         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2910         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2911         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2912
2913         // Create some initial channels
2914         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2915         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2916
2917         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 });
2918         // Get the will-be-revoked local txn from nodes[2]
2919         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2920         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2921         // Revoke the old state
2922         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
2923
2924         let value = if use_dust {
2925                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2926                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2927                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
2928         } else { 3000000 };
2929
2930         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2931         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2932         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2933
2934         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2935         expect_pending_htlcs_forwardable!(nodes[2]);
2936         check_added_monitors!(nodes[2], 1);
2937         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2938         assert!(updates.update_add_htlcs.is_empty());
2939         assert!(updates.update_fulfill_htlcs.is_empty());
2940         assert!(updates.update_fail_malformed_htlcs.is_empty());
2941         assert_eq!(updates.update_fail_htlcs.len(), 1);
2942         assert!(updates.update_fee.is_none());
2943         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2944         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2945         // Drop the last RAA from 3 -> 2
2946
2947         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2948         expect_pending_htlcs_forwardable!(nodes[2]);
2949         check_added_monitors!(nodes[2], 1);
2950         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2951         assert!(updates.update_add_htlcs.is_empty());
2952         assert!(updates.update_fulfill_htlcs.is_empty());
2953         assert!(updates.update_fail_malformed_htlcs.is_empty());
2954         assert_eq!(updates.update_fail_htlcs.len(), 1);
2955         assert!(updates.update_fee.is_none());
2956         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2957         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2958         check_added_monitors!(nodes[1], 1);
2959         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2960         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2961         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2962         check_added_monitors!(nodes[2], 1);
2963
2964         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2965         expect_pending_htlcs_forwardable!(nodes[2]);
2966         check_added_monitors!(nodes[2], 1);
2967         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2968         assert!(updates.update_add_htlcs.is_empty());
2969         assert!(updates.update_fulfill_htlcs.is_empty());
2970         assert!(updates.update_fail_malformed_htlcs.is_empty());
2971         assert_eq!(updates.update_fail_htlcs.len(), 1);
2972         assert!(updates.update_fee.is_none());
2973         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2974         // At this point first_payment_hash has dropped out of the latest two commitment
2975         // transactions that nodes[1] is tracking...
2976         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2977         check_added_monitors!(nodes[1], 1);
2978         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2979         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2980         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2981         check_added_monitors!(nodes[2], 1);
2982
2983         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2984         // on nodes[2]'s RAA.
2985         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
2986         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2987         let logger = test_utils::TestLogger::new();
2988         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
2989         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
2990         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2991         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2992         check_added_monitors!(nodes[1], 0);
2993
2994         if deliver_bs_raa {
2995                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2996                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2997                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2998                 check_added_monitors!(nodes[1], 1);
2999                 let events = nodes[1].node.get_and_clear_pending_events();
3000                 assert_eq!(events.len(), 1);
3001                 match events[0] {
3002                         Event::PendingHTLCsForwardable { .. } => { },
3003                         _ => panic!("Unexpected event"),
3004                 };
3005                 // Deliberately don't process the pending fail-back so they all fail back at once after
3006                 // block connection just like the !deliver_bs_raa case
3007         }
3008
3009         let mut failed_htlcs = HashSet::new();
3010         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3011
3012         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3013         check_added_monitors!(nodes[1], 1);
3014         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3015
3016         let events = nodes[1].node.get_and_clear_pending_events();
3017         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3018         match events[0] {
3019                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => { },
3020                 _ => panic!("Unexepected event"),
3021         }
3022         match events[1] {
3023                 Event::PaymentPathFailed { ref payment_hash, .. } => {
3024                         assert_eq!(*payment_hash, fourth_payment_hash);
3025                 },
3026                 _ => panic!("Unexpected event"),
3027         }
3028         if !deliver_bs_raa {
3029                 match events[2] {
3030                         Event::PendingHTLCsForwardable { .. } => { },
3031                         _ => panic!("Unexpected event"),
3032                 };
3033         }
3034         nodes[1].node.process_pending_htlc_forwards();
3035         check_added_monitors!(nodes[1], 1);
3036
3037         let events = nodes[1].node.get_and_clear_pending_msg_events();
3038         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3039         match events[if deliver_bs_raa { 1 } else { 0 }] {
3040                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3041                 _ => panic!("Unexpected event"),
3042         }
3043         match events[if deliver_bs_raa { 2 } else { 1 }] {
3044                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3045                         assert_eq!(channel_id, chan_2.2);
3046                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3047                 },
3048                 _ => panic!("Unexpected event"),
3049         }
3050         if deliver_bs_raa {
3051                 match events[0] {
3052                         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, .. } } => {
3053                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3054                                 assert_eq!(update_add_htlcs.len(), 1);
3055                                 assert!(update_fulfill_htlcs.is_empty());
3056                                 assert!(update_fail_htlcs.is_empty());
3057                                 assert!(update_fail_malformed_htlcs.is_empty());
3058                         },
3059                         _ => panic!("Unexpected event"),
3060                 }
3061         }
3062         match events[if deliver_bs_raa { 3 } else { 2 }] {
3063                 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, .. } } => {
3064                         assert!(update_add_htlcs.is_empty());
3065                         assert_eq!(update_fail_htlcs.len(), 3);
3066                         assert!(update_fulfill_htlcs.is_empty());
3067                         assert!(update_fail_malformed_htlcs.is_empty());
3068                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3069
3070                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3071                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3072                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3073
3074                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3075
3076                         let events = nodes[0].node.get_and_clear_pending_events();
3077                         assert_eq!(events.len(), 3);
3078                         match events[0] {
3079                                 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3080                                         assert!(failed_htlcs.insert(payment_hash.0));
3081                                         // If we delivered B's RAA we got an unknown preimage error, not something
3082                                         // that we should update our routing table for.
3083                                         if !deliver_bs_raa {
3084                                                 assert!(network_update.is_some());
3085                                         }
3086                                 },
3087                                 _ => panic!("Unexpected event"),
3088                         }
3089                         match events[1] {
3090                                 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3091                                         assert!(failed_htlcs.insert(payment_hash.0));
3092                                         assert!(network_update.is_some());
3093                                 },
3094                                 _ => panic!("Unexpected event"),
3095                         }
3096                         match events[2] {
3097                                 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest: _, ref network_update, .. } => {
3098                                         assert!(failed_htlcs.insert(payment_hash.0));
3099                                         assert!(network_update.is_some());
3100                                 },
3101                                 _ => panic!("Unexpected event"),
3102                         }
3103                 },
3104                 _ => panic!("Unexpected event"),
3105         }
3106
3107         assert!(failed_htlcs.contains(&first_payment_hash.0));
3108         assert!(failed_htlcs.contains(&second_payment_hash.0));
3109         assert!(failed_htlcs.contains(&third_payment_hash.0));
3110 }
3111
3112 #[test]
3113 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3114         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3115         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3116         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3117         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3118 }
3119
3120 #[test]
3121 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3122         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3123         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3124         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3125         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3126 }
3127
3128 #[test]
3129 fn fail_backward_pending_htlc_upon_channel_failure() {
3130         let chanmon_cfgs = create_chanmon_cfgs(2);
3131         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3132         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3133         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3134         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3135         let logger = test_utils::TestLogger::new();
3136
3137         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3138         {
3139                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3140                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3141                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3142                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3143                 check_added_monitors!(nodes[0], 1);
3144
3145                 let payment_event = {
3146                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3147                         assert_eq!(events.len(), 1);
3148                         SendEvent::from_event(events.remove(0))
3149                 };
3150                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3151                 assert_eq!(payment_event.msgs.len(), 1);
3152         }
3153
3154         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3155         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3156         {
3157                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3158                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3159                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3160                 check_added_monitors!(nodes[0], 0);
3161
3162                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3163         }
3164
3165         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3166         {
3167                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3168
3169                 let secp_ctx = Secp256k1::new();
3170                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3171                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3172                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3173                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3174                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3175                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3176                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3177
3178                 // Send a 0-msat update_add_htlc to fail the channel.
3179                 let update_add_htlc = msgs::UpdateAddHTLC {
3180                         channel_id: chan.2,
3181                         htlc_id: 0,
3182                         amount_msat: 0,
3183                         payment_hash,
3184                         cltv_expiry,
3185                         onion_routing_packet,
3186                 };
3187                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3188         }
3189         let events = nodes[0].node.get_and_clear_pending_events();
3190         assert_eq!(events.len(), 2);
3191         // Check that Alice fails backward the pending HTLC from the second payment.
3192         match events[0] {
3193                 Event::PaymentPathFailed { payment_hash, .. } => {
3194                         assert_eq!(payment_hash, failed_payment_hash);
3195                 },
3196                 _ => panic!("Unexpected event"),
3197         }
3198         match events[1] {
3199                 Event::ChannelClosed { reason: ClosureReason::ProcessingError { ref err }, .. } => {
3200                         assert_eq!(err, "Remote side tried to send a 0-msat HTLC");
3201                 },
3202                 _ => panic!("Unexpected event {:?}", events[1]),
3203         }
3204         check_closed_broadcast!(nodes[0], true);
3205         check_added_monitors!(nodes[0], 1);
3206 }
3207
3208 #[test]
3209 fn test_htlc_ignore_latest_remote_commitment() {
3210         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3211         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3212         let chanmon_cfgs = create_chanmon_cfgs(2);
3213         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3214         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3215         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3216         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3217
3218         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3219         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3220         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3221         check_closed_broadcast!(nodes[0], true);
3222         check_added_monitors!(nodes[0], 1);
3223         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
3224
3225         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3226         assert_eq!(node_txn.len(), 3);
3227         assert_eq!(node_txn[0], node_txn[1]);
3228
3229         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3230         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3231         check_closed_broadcast!(nodes[1], true);
3232         check_added_monitors!(nodes[1], 1);
3233         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3234
3235         // Duplicate the connect_block call since this may happen due to other listeners
3236         // registering new transactions
3237         header.prev_blockhash = header.block_hash();
3238         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3239 }
3240
3241 #[test]
3242 fn test_force_close_fail_back() {
3243         // Check which HTLCs are failed-backwards on channel force-closure
3244         let chanmon_cfgs = create_chanmon_cfgs(3);
3245         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3246         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3247         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3248         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3249         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3250         let logger = test_utils::TestLogger::new();
3251
3252         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3253
3254         let mut payment_event = {
3255                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3256                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3257                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3258                 check_added_monitors!(nodes[0], 1);
3259
3260                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3261                 assert_eq!(events.len(), 1);
3262                 SendEvent::from_event(events.remove(0))
3263         };
3264
3265         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3266         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3267
3268         expect_pending_htlcs_forwardable!(nodes[1]);
3269
3270         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3271         assert_eq!(events_2.len(), 1);
3272         payment_event = SendEvent::from_event(events_2.remove(0));
3273         assert_eq!(payment_event.msgs.len(), 1);
3274
3275         check_added_monitors!(nodes[1], 1);
3276         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3277         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3278         check_added_monitors!(nodes[2], 1);
3279         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3280
3281         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3282         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3283         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3284
3285         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3286         check_closed_broadcast!(nodes[2], true);
3287         check_added_monitors!(nodes[2], 1);
3288         check_closed_event!(nodes[2], 1, ClosureReason::HolderForceClosed);
3289         let tx = {
3290                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3291                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3292                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3293                 // back to nodes[1] upon timeout otherwise.
3294                 assert_eq!(node_txn.len(), 1);
3295                 node_txn.remove(0)
3296         };
3297
3298         mine_transaction(&nodes[1], &tx);
3299
3300         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3301         check_closed_broadcast!(nodes[1], true);
3302         check_added_monitors!(nodes[1], 1);
3303         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3304
3305         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3306         {
3307                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3308                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3309                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3310         }
3311         mine_transaction(&nodes[2], &tx);
3312         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3313         assert_eq!(node_txn.len(), 1);
3314         assert_eq!(node_txn[0].input.len(), 1);
3315         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3316         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3317         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3318
3319         check_spends!(node_txn[0], tx);
3320 }
3321
3322 #[test]
3323 fn test_dup_events_on_peer_disconnect() {
3324         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3325         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3326         // as we used to generate the event immediately upon receipt of the payment preimage in the
3327         // update_fulfill_htlc message.
3328
3329         let chanmon_cfgs = create_chanmon_cfgs(2);
3330         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3331         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3332         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3333         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3334
3335         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3336
3337         assert!(nodes[1].node.claim_funds(payment_preimage));
3338         check_added_monitors!(nodes[1], 1);
3339         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3340         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3341         expect_payment_sent!(nodes[0], payment_preimage);
3342
3343         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3344         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3345
3346         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3347         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3348 }
3349
3350 #[test]
3351 fn test_simple_peer_disconnect() {
3352         // Test that we can reconnect when there are no lost messages
3353         let chanmon_cfgs = create_chanmon_cfgs(3);
3354         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3355         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3356         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3357         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3358         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3359
3360         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3361         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3362         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3363
3364         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3365         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3366         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3367         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3368
3369         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3370         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3371         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3372
3373         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3374         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3375         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3376         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3377
3378         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3379         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3380
3381         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3382         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_hash_5);
3383
3384         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3385         {
3386                 let events = nodes[0].node.get_and_clear_pending_events();
3387                 assert_eq!(events.len(), 2);
3388                 match events[0] {
3389                         Event::PaymentSent { payment_preimage } => {
3390                                 assert_eq!(payment_preimage, payment_preimage_3);
3391                         },
3392                         _ => panic!("Unexpected event"),
3393                 }
3394                 match events[1] {
3395                         Event::PaymentPathFailed { payment_hash, rejected_by_dest, .. } => {
3396                                 assert_eq!(payment_hash, payment_hash_5);
3397                                 assert!(rejected_by_dest);
3398                         },
3399                         _ => panic!("Unexpected event"),
3400                 }
3401         }
3402
3403         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3404         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3405 }
3406
3407 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3408         // Test that we can reconnect when in-flight HTLC updates get dropped
3409         let chanmon_cfgs = create_chanmon_cfgs(2);
3410         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3411         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3412         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3413
3414         let mut as_funding_locked = None;
3415         if messages_delivered == 0 {
3416                 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3417                 as_funding_locked = Some(funding_locked);
3418                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3419                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3420                 // it before the channel_reestablish message.
3421         } else {
3422                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3423         }
3424
3425         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3426
3427         let logger = test_utils::TestLogger::new();
3428         let payment_event = {
3429                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3430                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3431                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3432                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3433                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3434                 check_added_monitors!(nodes[0], 1);
3435
3436                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3437                 assert_eq!(events.len(), 1);
3438                 SendEvent::from_event(events.remove(0))
3439         };
3440         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3441
3442         if messages_delivered < 2 {
3443                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3444         } else {
3445                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3446                 if messages_delivered >= 3 {
3447                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3448                         check_added_monitors!(nodes[1], 1);
3449                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3450
3451                         if messages_delivered >= 4 {
3452                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3453                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3454                                 check_added_monitors!(nodes[0], 1);
3455
3456                                 if messages_delivered >= 5 {
3457                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3458                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3459                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3460                                         check_added_monitors!(nodes[0], 1);
3461
3462                                         if messages_delivered >= 6 {
3463                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3464                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3465                                                 check_added_monitors!(nodes[1], 1);
3466                                         }
3467                                 }
3468                         }
3469                 }
3470         }
3471
3472         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3473         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3474         if messages_delivered < 3 {
3475                 if simulate_broken_lnd {
3476                         // lnd has a long-standing bug where they send a funding_locked prior to a
3477                         // channel_reestablish if you reconnect prior to funding_locked time.
3478                         //
3479                         // Here we simulate that behavior, delivering a funding_locked immediately on
3480                         // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3481                         // in `reconnect_nodes` but we currently don't fail based on that.
3482                         //
3483                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3484                         nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3485                 }
3486                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3487                 // received on either side, both sides will need to resend them.
3488                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3489         } else if messages_delivered == 3 {
3490                 // nodes[0] still wants its RAA + commitment_signed
3491                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3492         } else if messages_delivered == 4 {
3493                 // nodes[0] still wants its commitment_signed
3494                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3495         } else if messages_delivered == 5 {
3496                 // nodes[1] still wants its final RAA
3497                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3498         } else if messages_delivered == 6 {
3499                 // Everything was delivered...
3500                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3501         }
3502
3503         let events_1 = nodes[1].node.get_and_clear_pending_events();
3504         assert_eq!(events_1.len(), 1);
3505         match events_1[0] {
3506                 Event::PendingHTLCsForwardable { .. } => { },
3507                 _ => panic!("Unexpected event"),
3508         };
3509
3510         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3511         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3512         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3513
3514         nodes[1].node.process_pending_htlc_forwards();
3515
3516         let events_2 = nodes[1].node.get_and_clear_pending_events();
3517         assert_eq!(events_2.len(), 1);
3518         match events_2[0] {
3519                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
3520                         assert_eq!(payment_hash_1, *payment_hash);
3521                         assert_eq!(amt, 1000000);
3522                         match &purpose {
3523                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3524                                         assert!(payment_preimage.is_none());
3525                                         assert_eq!(payment_secret_1, *payment_secret);
3526                                 },
3527                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3528                         }
3529                 },
3530                 _ => panic!("Unexpected event"),
3531         }
3532
3533         nodes[1].node.claim_funds(payment_preimage_1);
3534         check_added_monitors!(nodes[1], 1);
3535
3536         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3537         assert_eq!(events_3.len(), 1);
3538         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3539                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3540                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3541                         assert!(updates.update_add_htlcs.is_empty());
3542                         assert!(updates.update_fail_htlcs.is_empty());
3543                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3544                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3545                         assert!(updates.update_fee.is_none());
3546                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3547                 },
3548                 _ => panic!("Unexpected event"),
3549         };
3550
3551         if messages_delivered >= 1 {
3552                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3553
3554                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3555                 assert_eq!(events_4.len(), 1);
3556                 match events_4[0] {
3557                         Event::PaymentSent { ref payment_preimage } => {
3558                                 assert_eq!(payment_preimage_1, *payment_preimage);
3559                         },
3560                         _ => panic!("Unexpected event"),
3561                 }
3562
3563                 if messages_delivered >= 2 {
3564                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3565                         check_added_monitors!(nodes[0], 1);
3566                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3567
3568                         if messages_delivered >= 3 {
3569                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3570                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3571                                 check_added_monitors!(nodes[1], 1);
3572
3573                                 if messages_delivered >= 4 {
3574                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3575                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3576                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3577                                         check_added_monitors!(nodes[1], 1);
3578
3579                                         if messages_delivered >= 5 {
3580                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3581                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3582                                                 check_added_monitors!(nodes[0], 1);
3583                                         }
3584                                 }
3585                         }
3586                 }
3587         }
3588
3589         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3590         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3591         if messages_delivered < 2 {
3592                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3593                 if messages_delivered < 1 {
3594                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3595                         assert_eq!(events_4.len(), 1);
3596                         match events_4[0] {
3597                                 Event::PaymentSent { ref payment_preimage } => {
3598                                         assert_eq!(payment_preimage_1, *payment_preimage);
3599                                 },
3600                                 _ => panic!("Unexpected event"),
3601                         }
3602                 } else {
3603                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3604                 }
3605         } else if messages_delivered == 2 {
3606                 // nodes[0] still wants its RAA + commitment_signed
3607                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3608         } else if messages_delivered == 3 {
3609                 // nodes[0] still wants its commitment_signed
3610                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3611         } else if messages_delivered == 4 {
3612                 // nodes[1] still wants its final RAA
3613                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3614         } else if messages_delivered == 5 {
3615                 // Everything was delivered...
3616                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3617         }
3618
3619         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3620         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3621         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3622
3623         // Channel should still work fine...
3624         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3625         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3626                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3627                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3628         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3629         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3630 }
3631
3632 #[test]
3633 fn test_drop_messages_peer_disconnect_a() {
3634         do_test_drop_messages_peer_disconnect(0, true);
3635         do_test_drop_messages_peer_disconnect(0, false);
3636         do_test_drop_messages_peer_disconnect(1, false);
3637         do_test_drop_messages_peer_disconnect(2, false);
3638 }
3639
3640 #[test]
3641 fn test_drop_messages_peer_disconnect_b() {
3642         do_test_drop_messages_peer_disconnect(3, false);
3643         do_test_drop_messages_peer_disconnect(4, false);
3644         do_test_drop_messages_peer_disconnect(5, false);
3645         do_test_drop_messages_peer_disconnect(6, false);
3646 }
3647
3648 #[test]
3649 fn test_funding_peer_disconnect() {
3650         // Test that we can lock in our funding tx while disconnected
3651         let chanmon_cfgs = create_chanmon_cfgs(2);
3652         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3653         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3654         let persister: test_utils::TestPersister;
3655         let new_chain_monitor: test_utils::TestChainMonitor;
3656         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3657         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3658         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3659
3660         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3661         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3662
3663         confirm_transaction(&nodes[0], &tx);
3664         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3665         assert_eq!(events_1.len(), 1);
3666         match events_1[0] {
3667                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3668                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3669                 },
3670                 _ => panic!("Unexpected event"),
3671         }
3672
3673         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3674
3675         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3676         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3677
3678         confirm_transaction(&nodes[1], &tx);
3679         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3680         assert_eq!(events_2.len(), 2);
3681         let funding_locked = match events_2[0] {
3682                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3683                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3684                         msg.clone()
3685                 },
3686                 _ => panic!("Unexpected event"),
3687         };
3688         let bs_announcement_sigs = match events_2[1] {
3689                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3690                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3691                         msg.clone()
3692                 },
3693                 _ => panic!("Unexpected event"),
3694         };
3695
3696         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3697
3698         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3699         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3700         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3701         assert_eq!(events_3.len(), 2);
3702         let as_announcement_sigs = match events_3[0] {
3703                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3704                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3705                         msg.clone()
3706                 },
3707                 _ => panic!("Unexpected event"),
3708         };
3709         let (as_announcement, as_update) = match events_3[1] {
3710                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3711                         (msg.clone(), update_msg.clone())
3712                 },
3713                 _ => panic!("Unexpected event"),
3714         };
3715
3716         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3717         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3718         assert_eq!(events_4.len(), 1);
3719         let (_, bs_update) = match events_4[0] {
3720                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3721                         (msg.clone(), update_msg.clone())
3722                 },
3723                 _ => panic!("Unexpected event"),
3724         };
3725
3726         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3727         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3728         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3729
3730         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3731         let logger = test_utils::TestLogger::new();
3732         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3733         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3734         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3735
3736         // Check that after deserialization and reconnection we can still generate an identical
3737         // channel_announcement from the cached signatures.
3738         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3739
3740         let nodes_0_serialized = nodes[0].node.encode();
3741         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3742         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3743
3744         persister = test_utils::TestPersister::new();
3745         let keys_manager = &chanmon_cfgs[0].keys_manager;
3746         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
3747         nodes[0].chain_monitor = &new_chain_monitor;
3748         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3749         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3750                 &mut chan_0_monitor_read, keys_manager).unwrap();
3751         assert!(chan_0_monitor_read.is_empty());
3752
3753         let mut nodes_0_read = &nodes_0_serialized[..];
3754         let (_, nodes_0_deserialized_tmp) = {
3755                 let mut channel_monitors = HashMap::new();
3756                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3757                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3758                         default_config: UserConfig::default(),
3759                         keys_manager,
3760                         fee_estimator: node_cfgs[0].fee_estimator,
3761                         chain_monitor: nodes[0].chain_monitor,
3762                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3763                         logger: nodes[0].logger,
3764                         channel_monitors,
3765                 }).unwrap()
3766         };
3767         nodes_0_deserialized = nodes_0_deserialized_tmp;
3768         assert!(nodes_0_read.is_empty());
3769
3770         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3771         nodes[0].node = &nodes_0_deserialized;
3772         check_added_monitors!(nodes[0], 1);
3773
3774         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3775
3776         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3777         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3778         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3779         let mut found_announcement = false;
3780         for event in msgs.iter() {
3781                 match event {
3782                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3783                                 if *msg == as_announcement { found_announcement = true; }
3784                         },
3785                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3786                         _ => panic!("Unexpected event"),
3787                 }
3788         }
3789         assert!(found_announcement);
3790 }
3791
3792 #[test]
3793 fn test_drop_messages_peer_disconnect_dual_htlc() {
3794         // Test that we can handle reconnecting when both sides of a channel have pending
3795         // commitment_updates when we disconnect.
3796         let chanmon_cfgs = create_chanmon_cfgs(2);
3797         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3798         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3799         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3800         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3801         let logger = test_utils::TestLogger::new();
3802
3803         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3804
3805         // Now try to send a second payment which will fail to send
3806         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3807         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3808         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3809         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3810         check_added_monitors!(nodes[0], 1);
3811
3812         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3813         assert_eq!(events_1.len(), 1);
3814         match events_1[0] {
3815                 MessageSendEvent::UpdateHTLCs { .. } => {},
3816                 _ => panic!("Unexpected event"),
3817         }
3818
3819         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3820         check_added_monitors!(nodes[1], 1);
3821
3822         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3823         assert_eq!(events_2.len(), 1);
3824         match events_2[0] {
3825                 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 } } => {
3826                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3827                         assert!(update_add_htlcs.is_empty());
3828                         assert_eq!(update_fulfill_htlcs.len(), 1);
3829                         assert!(update_fail_htlcs.is_empty());
3830                         assert!(update_fail_malformed_htlcs.is_empty());
3831                         assert!(update_fee.is_none());
3832
3833                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3834                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3835                         assert_eq!(events_3.len(), 1);
3836                         match events_3[0] {
3837                                 Event::PaymentSent { ref payment_preimage } => {
3838                                         assert_eq!(*payment_preimage, payment_preimage_1);
3839                                 },
3840                                 _ => panic!("Unexpected event"),
3841                         }
3842
3843                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3844                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3845                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3846                         check_added_monitors!(nodes[0], 1);
3847                 },
3848                 _ => panic!("Unexpected event"),
3849         }
3850
3851         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3852         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3853
3854         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3855         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3856         assert_eq!(reestablish_1.len(), 1);
3857         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3858         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3859         assert_eq!(reestablish_2.len(), 1);
3860
3861         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3862         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3863         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3864         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3865
3866         assert!(as_resp.0.is_none());
3867         assert!(bs_resp.0.is_none());
3868
3869         assert!(bs_resp.1.is_none());
3870         assert!(bs_resp.2.is_none());
3871
3872         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3873
3874         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3875         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3876         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3877         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3878         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3879         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3880         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3881         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3882         // No commitment_signed so get_event_msg's assert(len == 1) passes
3883         check_added_monitors!(nodes[1], 1);
3884
3885         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3886         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3887         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3888         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3889         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3890         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3891         assert!(bs_second_commitment_signed.update_fee.is_none());
3892         check_added_monitors!(nodes[1], 1);
3893
3894         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3895         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3896         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3897         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3898         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3899         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3900         assert!(as_commitment_signed.update_fee.is_none());
3901         check_added_monitors!(nodes[0], 1);
3902
3903         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3904         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3905         // No commitment_signed so get_event_msg's assert(len == 1) passes
3906         check_added_monitors!(nodes[0], 1);
3907
3908         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3909         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3910         // No commitment_signed so get_event_msg's assert(len == 1) passes
3911         check_added_monitors!(nodes[1], 1);
3912
3913         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3914         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3915         check_added_monitors!(nodes[1], 1);
3916
3917         expect_pending_htlcs_forwardable!(nodes[1]);
3918
3919         let events_5 = nodes[1].node.get_and_clear_pending_events();
3920         assert_eq!(events_5.len(), 1);
3921         match events_5[0] {
3922                 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
3923                         assert_eq!(payment_hash_2, *payment_hash);
3924                         match &purpose {
3925                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3926                                         assert!(payment_preimage.is_none());
3927                                         assert_eq!(payment_secret_2, *payment_secret);
3928                                 },
3929                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3930                         }
3931                 },
3932                 _ => panic!("Unexpected event"),
3933         }
3934
3935         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3936         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3937         check_added_monitors!(nodes[0], 1);
3938
3939         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3940 }
3941
3942 fn do_test_htlc_timeout(send_partial_mpp: bool) {
3943         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
3944         // to avoid our counterparty failing the channel.
3945         let chanmon_cfgs = create_chanmon_cfgs(2);
3946         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3947         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3948         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3949
3950         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3951         let logger = test_utils::TestLogger::new();
3952
3953         let our_payment_hash = if send_partial_mpp {
3954                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3955                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
3956                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
3957                 // Use the utility function send_payment_along_path to send the payment with MPP data which
3958                 // indicates there are more HTLCs coming.
3959                 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.
3960                 let payment_id = PaymentId([42; 32]);
3961                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height, payment_id, &None).unwrap();
3962                 check_added_monitors!(nodes[0], 1);
3963                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3964                 assert_eq!(events.len(), 1);
3965                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
3966                 // hop should *not* yet generate any PaymentReceived event(s).
3967                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
3968                 our_payment_hash
3969         } else {
3970                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
3971         };
3972
3973         let mut block = Block {
3974                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3975                 txdata: vec![],
3976         };
3977         connect_block(&nodes[0], &block);
3978         connect_block(&nodes[1], &block);
3979         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
3980         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
3981                 block.header.prev_blockhash = block.block_hash();
3982                 connect_block(&nodes[0], &block);
3983                 connect_block(&nodes[1], &block);
3984         }
3985
3986         expect_pending_htlcs_forwardable!(nodes[1]);
3987
3988         check_added_monitors!(nodes[1], 1);
3989         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3990         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
3991         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
3992         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
3993         assert!(htlc_timeout_updates.update_fee.is_none());
3994
3995         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
3996         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
3997         // 100_000 msat as u64, followed by the height at which we failed back above
3998         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
3999         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4000         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4001 }
4002
4003 #[test]
4004 fn test_htlc_timeout() {
4005         do_test_htlc_timeout(true);
4006         do_test_htlc_timeout(false);
4007 }
4008
4009 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4010         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4011         let chanmon_cfgs = create_chanmon_cfgs(3);
4012         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4013         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4014         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4015         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4016         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4017
4018         // Make sure all nodes are at the same starting height
4019         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4020         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4021         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4022
4023         let logger = test_utils::TestLogger::new();
4024
4025         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4026         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4027         {
4028                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4029                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4030                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4031         }
4032         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4033         check_added_monitors!(nodes[1], 1);
4034
4035         // Now attempt to route a second payment, which should be placed in the holding cell
4036         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4037         if forwarded_htlc {
4038                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4039                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4040                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4041                 check_added_monitors!(nodes[0], 1);
4042                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4043                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4044                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4045                 expect_pending_htlcs_forwardable!(nodes[1]);
4046                 check_added_monitors!(nodes[1], 0);
4047         } else {
4048                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4049                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4050                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4051                 check_added_monitors!(nodes[1], 0);
4052         }
4053
4054         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4055         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4056         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4057         connect_blocks(&nodes[1], 1);
4058
4059         if forwarded_htlc {
4060                 expect_pending_htlcs_forwardable!(nodes[1]);
4061                 check_added_monitors!(nodes[1], 1);
4062                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4063                 assert_eq!(fail_commit.len(), 1);
4064                 match fail_commit[0] {
4065                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4066                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4067                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4068                         },
4069                         _ => unreachable!(),
4070                 }
4071                 expect_payment_failed_with_update!(nodes[0], second_payment_hash, false, chan_2.0.contents.short_channel_id, false);
4072         } else {
4073                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4074         }
4075 }
4076
4077 #[test]
4078 fn test_holding_cell_htlc_add_timeouts() {
4079         do_test_holding_cell_htlc_add_timeouts(false);
4080         do_test_holding_cell_htlc_add_timeouts(true);
4081 }
4082
4083 #[test]
4084 fn test_no_txn_manager_serialize_deserialize() {
4085         let chanmon_cfgs = create_chanmon_cfgs(2);
4086         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4087         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4088         let logger: test_utils::TestLogger;
4089         let fee_estimator: test_utils::TestFeeEstimator;
4090         let persister: test_utils::TestPersister;
4091         let new_chain_monitor: test_utils::TestChainMonitor;
4092         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4093         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4094
4095         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4096
4097         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4098
4099         let nodes_0_serialized = nodes[0].node.encode();
4100         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4101         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4102
4103         logger = test_utils::TestLogger::new();
4104         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4105         persister = test_utils::TestPersister::new();
4106         let keys_manager = &chanmon_cfgs[0].keys_manager;
4107         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4108         nodes[0].chain_monitor = &new_chain_monitor;
4109         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4110         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4111                 &mut chan_0_monitor_read, keys_manager).unwrap();
4112         assert!(chan_0_monitor_read.is_empty());
4113
4114         let mut nodes_0_read = &nodes_0_serialized[..];
4115         let config = UserConfig::default();
4116         let (_, nodes_0_deserialized_tmp) = {
4117                 let mut channel_monitors = HashMap::new();
4118                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4119                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4120                         default_config: config,
4121                         keys_manager,
4122                         fee_estimator: &fee_estimator,
4123                         chain_monitor: nodes[0].chain_monitor,
4124                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4125                         logger: &logger,
4126                         channel_monitors,
4127                 }).unwrap()
4128         };
4129         nodes_0_deserialized = nodes_0_deserialized_tmp;
4130         assert!(nodes_0_read.is_empty());
4131
4132         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4133         nodes[0].node = &nodes_0_deserialized;
4134         assert_eq!(nodes[0].node.list_channels().len(), 1);
4135         check_added_monitors!(nodes[0], 1);
4136
4137         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4138         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4139         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4140         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4141
4142         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4143         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4144         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4145         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4146
4147         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4148         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4149         for node in nodes.iter() {
4150                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4151                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4152                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4153         }
4154
4155         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4156 }
4157
4158 #[test]
4159 fn mpp_failure() {
4160         let chanmon_cfgs = create_chanmon_cfgs(4);
4161         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4162         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4163         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4164
4165         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4166         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4167         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4168         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4169         let logger = test_utils::TestLogger::new();
4170
4171         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
4172         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4173         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
4174         let path = route.paths[0].clone();
4175         route.paths.push(path);
4176         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
4177         route.paths[0][0].short_channel_id = chan_1_id;
4178         route.paths[0][1].short_channel_id = chan_3_id;
4179         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
4180         route.paths[1][0].short_channel_id = chan_2_id;
4181         route.paths[1][1].short_channel_id = chan_4_id;
4182         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
4183         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
4184 }
4185
4186 #[test]
4187 fn mpp_retry() {
4188         let chanmon_cfgs = create_chanmon_cfgs(4);
4189         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4190         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4191         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4192
4193         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4194         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4195         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4196         let chan_4_id = create_announced_chan_between_nodes(&nodes, 3, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4197         let logger = test_utils::TestLogger::new();
4198         // Rebalance
4199         send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
4200
4201         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
4202         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4203         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1_000_000, TEST_FINAL_CLTV, &logger).unwrap();
4204         let path = route.paths[0].clone();
4205         route.paths.push(path);
4206         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
4207         route.paths[0][0].short_channel_id = chan_1_id;
4208         route.paths[0][1].short_channel_id = chan_3_id;
4209         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
4210         route.paths[1][0].short_channel_id = chan_2_id;
4211         route.paths[1][1].short_channel_id = chan_4_id;
4212
4213         // Initiate the MPP payment.
4214         let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
4215         check_added_monitors!(nodes[0], 2); // one monitor per path
4216         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4217         assert_eq!(events.len(), 2);
4218
4219         // Pass half of the payment along the success path.
4220         let success_path_msgs = events.remove(0);
4221         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), success_path_msgs, false, None);
4222
4223         // Add the HTLC along the first hop.
4224         let fail_path_msgs_1 = events.remove(0);
4225         let (update_add, commitment_signed) = match fail_path_msgs_1 {
4226                 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 } } => {
4227                         assert_eq!(update_add_htlcs.len(), 1);
4228                         assert!(update_fail_htlcs.is_empty());
4229                         assert!(update_fulfill_htlcs.is_empty());
4230                         assert!(update_fail_malformed_htlcs.is_empty());
4231                         assert!(update_fee.is_none());
4232                         (update_add_htlcs[0].clone(), commitment_signed.clone())
4233                 },
4234                 _ => panic!("Unexpected event"),
4235         };
4236         nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
4237         commitment_signed_dance!(nodes[2], nodes[0], commitment_signed, false);
4238
4239         // Attempt to forward the payment and complete the 2nd path's failure.
4240         expect_pending_htlcs_forwardable!(&nodes[2]);
4241         expect_pending_htlcs_forwardable!(&nodes[2]);
4242         let htlc_updates = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
4243         assert!(htlc_updates.update_add_htlcs.is_empty());
4244         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4245         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4246         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4247         check_added_monitors!(nodes[2], 1);
4248         nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4249         commitment_signed_dance!(nodes[0], nodes[2], htlc_updates.commitment_signed, false);
4250         expect_payment_failed!(nodes[0], payment_hash, false);
4251
4252         // Rebalance the channel so the second half of the payment can succeed.
4253         send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
4254
4255         // Make sure it errors as expected given a too-large amount.
4256         if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, payment_id) {
4257                 assert!(err.contains("over total_payment_amt_msat"));
4258         } else { panic!("Unexpected error"); }
4259
4260         // Make sure it errors as expected given the wrong payment_id.
4261         if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, PaymentId([0; 32])) {
4262                 assert!(err.contains("not found"));
4263         } else { panic!("Unexpected error"); }
4264
4265         // Retry the second half of the payment and make sure it succeeds.
4266         let mut path = route.clone();
4267         path.paths.remove(0);
4268         nodes[0].node.retry_payment(&path, payment_id).unwrap();
4269         check_added_monitors!(nodes[0], 1);
4270         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4271         assert_eq!(events.len(), 1);
4272         pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
4273         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
4274 }
4275
4276 #[test]
4277 fn retry_single_path_payment() {
4278         let chanmon_cfgs = create_chanmon_cfgs(3);
4279         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4280         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4281         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4282
4283         let _chan_0 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4284         let _chan_1 = create_announced_chan_between_nodes(&nodes, 2, 1, InitFeatures::known(), InitFeatures::known());
4285         // Rebalance to find a route
4286         send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
4287
4288         let logger = test_utils::TestLogger::new();
4289         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
4290         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4291         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
4292
4293         // Rebalance so that the first hop fails.
4294         send_payment(&nodes[1], &vec!(&nodes[2])[..], 2_000_000);
4295
4296         // Make sure the payment fails on the first hop.
4297         let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
4298         check_added_monitors!(nodes[0], 1);
4299         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4300         assert_eq!(events.len(), 1);
4301         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
4302         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4303         check_added_monitors!(nodes[1], 0);
4304         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4305         expect_pending_htlcs_forwardable!(nodes[1]);
4306         expect_pending_htlcs_forwardable!(&nodes[1]);
4307         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4308         assert!(htlc_updates.update_add_htlcs.is_empty());
4309         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4310         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4311         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4312         check_added_monitors!(nodes[1], 1);
4313         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4314         commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false);
4315         expect_payment_failed!(nodes[0], payment_hash, false);
4316
4317         // Rebalance the channel so the retry succeeds.
4318         send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
4319
4320         // Mine two blocks (we expire retries after 3, so this will check that we don't expire early)
4321         connect_blocks(&nodes[0], 2);
4322
4323         // Retry the payment and make sure it succeeds.
4324         nodes[0].node.retry_payment(&route, payment_id).unwrap();
4325         check_added_monitors!(nodes[0], 1);
4326         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4327         assert_eq!(events.len(), 1);
4328         pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], 100_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
4329         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
4330 }
4331
4332 #[test]
4333 fn retry_expired_payment() {
4334         let chanmon_cfgs = create_chanmon_cfgs(3);
4335         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4336         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4337         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4338
4339         let _chan_0 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4340         let _chan_1 = create_announced_chan_between_nodes(&nodes, 2, 1, InitFeatures::known(), InitFeatures::known());
4341         // Rebalance to find a route
4342         send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
4343
4344         let logger = test_utils::TestLogger::new();
4345         let (_payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
4346         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4347         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
4348
4349         // Rebalance so that the first hop fails.
4350         send_payment(&nodes[1], &vec!(&nodes[2])[..], 2_000_000);
4351
4352         // Make sure the payment fails on the first hop.
4353         let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
4354         check_added_monitors!(nodes[0], 1);
4355         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4356         assert_eq!(events.len(), 1);
4357         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
4358         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4359         check_added_monitors!(nodes[1], 0);
4360         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4361         expect_pending_htlcs_forwardable!(nodes[1]);
4362         expect_pending_htlcs_forwardable!(&nodes[1]);
4363         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4364         assert!(htlc_updates.update_add_htlcs.is_empty());
4365         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4366         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4367         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4368         check_added_monitors!(nodes[1], 1);
4369         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4370         commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false);
4371         expect_payment_failed!(nodes[0], payment_hash, false);
4372
4373         // Mine blocks so the payment will have expired.
4374         connect_blocks(&nodes[0], 3);
4375
4376         // Retry the payment and make sure it errors as expected.
4377         if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, payment_id) {
4378                 assert!(err.contains("not found"));
4379         } else {
4380                 panic!("Unexpected error");
4381         }
4382 }
4383
4384 #[test]
4385 fn test_dup_htlc_onchain_fails_on_reload() {
4386         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4387         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4388         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4389         // the ChannelMonitor tells it to.
4390         //
4391         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4392         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4393         // PaymentPathFailed event appearing). However, because we may not serialize the relevant
4394         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4395         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4396         // and de-duplicates ChannelMonitor events.
4397         //
4398         // This tests that explicit tracking behavior.
4399         let chanmon_cfgs = create_chanmon_cfgs(2);
4400         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4401         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4402         let persister: test_utils::TestPersister;
4403         let new_chain_monitor: test_utils::TestChainMonitor;
4404         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4405         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4406
4407         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4408
4409         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4410         // nodes[0].
4411         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4412         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4413         check_closed_broadcast!(nodes[0], true);
4414         check_added_monitors!(nodes[0], 1);
4415         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
4416
4417         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4418         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4419
4420         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4421         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4422         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4423         assert_eq!(node_txn.len(), 3);
4424         assert_eq!(node_txn[0], node_txn[1]);
4425
4426         assert!(nodes[1].node.claim_funds(payment_preimage));
4427         check_added_monitors!(nodes[1], 1);
4428
4429         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4430         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4431         check_closed_broadcast!(nodes[1], true);
4432         check_added_monitors!(nodes[1], 1);
4433         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4434         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4435
4436         header.prev_blockhash = nodes[0].best_block_hash();
4437         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4438
4439         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4440         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4441         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4442         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4443         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4444
4445         header.prev_blockhash = nodes[0].best_block_hash();
4446         let claim_block = Block { header, txdata: claim_txn};
4447         connect_block(&nodes[0], &claim_block);
4448         expect_payment_sent!(nodes[0], payment_preimage);
4449
4450         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4451         // connected a highly-relevant block, it likely gets serialized out now.
4452         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4453         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4454
4455         // Now reload nodes[0]...
4456         persister = test_utils::TestPersister::new();
4457         let keys_manager = &chanmon_cfgs[0].keys_manager;
4458         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
4459         nodes[0].chain_monitor = &new_chain_monitor;
4460         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4461         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4462                 &mut chan_0_monitor_read, keys_manager).unwrap();
4463         assert!(chan_0_monitor_read.is_empty());
4464
4465         let (_, nodes_0_deserialized_tmp) = {
4466                 let mut channel_monitors = HashMap::new();
4467                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4468                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4469                         ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4470                                 default_config: Default::default(),
4471                                 keys_manager,
4472                                 fee_estimator: node_cfgs[0].fee_estimator,
4473                                 chain_monitor: nodes[0].chain_monitor,
4474                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4475                                 logger: nodes[0].logger,
4476                                 channel_monitors,
4477                         }).unwrap()
4478         };
4479         nodes_0_deserialized = nodes_0_deserialized_tmp;
4480
4481         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4482         check_added_monitors!(nodes[0], 1);
4483         nodes[0].node = &nodes_0_deserialized;
4484
4485         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4486         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4487         // payment events should kick in, leaving us with no pending events here.
4488         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4489         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4490         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4491 }
4492
4493 #[test]
4494 fn test_manager_serialize_deserialize_events() {
4495         // This test makes sure the events field in ChannelManager survives de/serialization
4496         let chanmon_cfgs = create_chanmon_cfgs(2);
4497         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4498         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4499         let fee_estimator: test_utils::TestFeeEstimator;
4500         let persister: test_utils::TestPersister;
4501         let logger: test_utils::TestLogger;
4502         let new_chain_monitor: test_utils::TestChainMonitor;
4503         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4504         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4505
4506         // Start creating a channel, but stop right before broadcasting the funding transaction
4507         let channel_value = 100000;
4508         let push_msat = 10001;
4509         let a_flags = InitFeatures::known();
4510         let b_flags = InitFeatures::known();
4511         let node_a = nodes.remove(0);
4512         let node_b = nodes.remove(0);
4513         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4514         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()));
4515         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()));
4516
4517         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4518
4519         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4520         check_added_monitors!(node_a, 0);
4521
4522         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()));
4523         {
4524                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4525                 assert_eq!(added_monitors.len(), 1);
4526                 assert_eq!(added_monitors[0].0, funding_output);
4527                 added_monitors.clear();
4528         }
4529
4530         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()));
4531         {
4532                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4533                 assert_eq!(added_monitors.len(), 1);
4534                 assert_eq!(added_monitors[0].0, funding_output);
4535                 added_monitors.clear();
4536         }
4537         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4538
4539         nodes.push(node_a);
4540         nodes.push(node_b);
4541
4542         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4543         let nodes_0_serialized = nodes[0].node.encode();
4544         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4545         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4546
4547         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4548         logger = test_utils::TestLogger::new();
4549         persister = test_utils::TestPersister::new();
4550         let keys_manager = &chanmon_cfgs[0].keys_manager;
4551         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4552         nodes[0].chain_monitor = &new_chain_monitor;
4553         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4554         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4555                 &mut chan_0_monitor_read, keys_manager).unwrap();
4556         assert!(chan_0_monitor_read.is_empty());
4557
4558         let mut nodes_0_read = &nodes_0_serialized[..];
4559         let config = UserConfig::default();
4560         let (_, nodes_0_deserialized_tmp) = {
4561                 let mut channel_monitors = HashMap::new();
4562                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4563                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4564                         default_config: config,
4565                         keys_manager,
4566                         fee_estimator: &fee_estimator,
4567                         chain_monitor: nodes[0].chain_monitor,
4568                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4569                         logger: &logger,
4570                         channel_monitors,
4571                 }).unwrap()
4572         };
4573         nodes_0_deserialized = nodes_0_deserialized_tmp;
4574         assert!(nodes_0_read.is_empty());
4575
4576         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4577
4578         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4579         nodes[0].node = &nodes_0_deserialized;
4580
4581         // After deserializing, make sure the funding_transaction is still held by the channel manager
4582         let events_4 = nodes[0].node.get_and_clear_pending_events();
4583         assert_eq!(events_4.len(), 0);
4584         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4585         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4586
4587         // Make sure the channel is functioning as though the de/serialization never happened
4588         assert_eq!(nodes[0].node.list_channels().len(), 1);
4589         check_added_monitors!(nodes[0], 1);
4590
4591         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4592         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4593         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4594         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4595
4596         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4597         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4598         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4599         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4600
4601         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4602         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4603         for node in nodes.iter() {
4604                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4605                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4606                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4607         }
4608
4609         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4610 }
4611
4612 #[test]
4613 fn test_simple_manager_serialize_deserialize() {
4614         let chanmon_cfgs = create_chanmon_cfgs(2);
4615         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4616         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4617         let logger: test_utils::TestLogger;
4618         let fee_estimator: test_utils::TestFeeEstimator;
4619         let persister: test_utils::TestPersister;
4620         let new_chain_monitor: test_utils::TestChainMonitor;
4621         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4622         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4623         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4624
4625         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4626         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4627
4628         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4629
4630         let nodes_0_serialized = nodes[0].node.encode();
4631         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4632         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4633
4634         logger = test_utils::TestLogger::new();
4635         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4636         persister = test_utils::TestPersister::new();
4637         let keys_manager = &chanmon_cfgs[0].keys_manager;
4638         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4639         nodes[0].chain_monitor = &new_chain_monitor;
4640         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4641         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4642                 &mut chan_0_monitor_read, keys_manager).unwrap();
4643         assert!(chan_0_monitor_read.is_empty());
4644
4645         let mut nodes_0_read = &nodes_0_serialized[..];
4646         let (_, nodes_0_deserialized_tmp) = {
4647                 let mut channel_monitors = HashMap::new();
4648                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4649                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4650                         default_config: UserConfig::default(),
4651                         keys_manager,
4652                         fee_estimator: &fee_estimator,
4653                         chain_monitor: nodes[0].chain_monitor,
4654                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4655                         logger: &logger,
4656                         channel_monitors,
4657                 }).unwrap()
4658         };
4659         nodes_0_deserialized = nodes_0_deserialized_tmp;
4660         assert!(nodes_0_read.is_empty());
4661
4662         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4663         nodes[0].node = &nodes_0_deserialized;
4664         check_added_monitors!(nodes[0], 1);
4665
4666         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4667
4668         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4669         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4670 }
4671
4672 #[test]
4673 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4674         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4675         let chanmon_cfgs = create_chanmon_cfgs(4);
4676         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4677         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4678         let logger: test_utils::TestLogger;
4679         let fee_estimator: test_utils::TestFeeEstimator;
4680         let persister: test_utils::TestPersister;
4681         let new_chain_monitor: test_utils::TestChainMonitor;
4682         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4683         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4684         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4685         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4686         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4687
4688         let mut node_0_stale_monitors_serialized = Vec::new();
4689         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4690                 let mut writer = test_utils::TestVecWriter(Vec::new());
4691                 monitor.1.write(&mut writer).unwrap();
4692                 node_0_stale_monitors_serialized.push(writer.0);
4693         }
4694
4695         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4696
4697         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4698         let nodes_0_serialized = nodes[0].node.encode();
4699
4700         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4701         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4702         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4703         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4704
4705         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4706         // nodes[3])
4707         let mut node_0_monitors_serialized = Vec::new();
4708         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4709                 let mut writer = test_utils::TestVecWriter(Vec::new());
4710                 monitor.1.write(&mut writer).unwrap();
4711                 node_0_monitors_serialized.push(writer.0);
4712         }
4713
4714         logger = test_utils::TestLogger::new();
4715         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4716         persister = test_utils::TestPersister::new();
4717         let keys_manager = &chanmon_cfgs[0].keys_manager;
4718         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4719         nodes[0].chain_monitor = &new_chain_monitor;
4720
4721
4722         let mut node_0_stale_monitors = Vec::new();
4723         for serialized in node_0_stale_monitors_serialized.iter() {
4724                 let mut read = &serialized[..];
4725                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4726                 assert!(read.is_empty());
4727                 node_0_stale_monitors.push(monitor);
4728         }
4729
4730         let mut node_0_monitors = Vec::new();
4731         for serialized in node_0_monitors_serialized.iter() {
4732                 let mut read = &serialized[..];
4733                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4734                 assert!(read.is_empty());
4735                 node_0_monitors.push(monitor);
4736         }
4737
4738         let mut nodes_0_read = &nodes_0_serialized[..];
4739         if let Err(msgs::DecodeError::InvalidValue) =
4740                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4741                 default_config: UserConfig::default(),
4742                 keys_manager,
4743                 fee_estimator: &fee_estimator,
4744                 chain_monitor: nodes[0].chain_monitor,
4745                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4746                 logger: &logger,
4747                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4748         }) { } else {
4749                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4750         };
4751
4752         let mut nodes_0_read = &nodes_0_serialized[..];
4753         let (_, nodes_0_deserialized_tmp) =
4754                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4755                 default_config: UserConfig::default(),
4756                 keys_manager,
4757                 fee_estimator: &fee_estimator,
4758                 chain_monitor: nodes[0].chain_monitor,
4759                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4760                 logger: &logger,
4761                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4762         }).unwrap();
4763         nodes_0_deserialized = nodes_0_deserialized_tmp;
4764         assert!(nodes_0_read.is_empty());
4765
4766         { // Channel close should result in a commitment tx
4767                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4768                 assert_eq!(txn.len(), 1);
4769                 check_spends!(txn[0], funding_tx);
4770                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4771         }
4772
4773         for monitor in node_0_monitors.drain(..) {
4774                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4775                 check_added_monitors!(nodes[0], 1);
4776         }
4777         nodes[0].node = &nodes_0_deserialized;
4778         check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager);
4779
4780         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4781         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4782         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4783         //... and we can even still claim the payment!
4784         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4785
4786         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4787         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4788         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4789         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4790         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4791         assert_eq!(msg_events.len(), 1);
4792         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4793                 match action {
4794                         &ErrorAction::SendErrorMessage { ref msg } => {
4795                                 assert_eq!(msg.channel_id, channel_id);
4796                         },
4797                         _ => panic!("Unexpected event!"),
4798                 }
4799         }
4800 }
4801
4802 macro_rules! check_spendable_outputs {
4803         ($node: expr, $keysinterface: expr) => {
4804                 {
4805                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4806                         let mut txn = Vec::new();
4807                         let mut all_outputs = Vec::new();
4808                         let secp_ctx = Secp256k1::new();
4809                         for event in events.drain(..) {
4810                                 match event {
4811                                         Event::SpendableOutputs { mut outputs } => {
4812                                                 for outp in outputs.drain(..) {
4813                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4814                                                         all_outputs.push(outp);
4815                                                 }
4816                                         },
4817                                         _ => panic!("Unexpected event"),
4818                                 };
4819                         }
4820                         if all_outputs.len() > 1 {
4821                                 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) {
4822                                         txn.push(tx);
4823                                 }
4824                         }
4825                         txn
4826                 }
4827         }
4828 }
4829
4830 #[test]
4831 fn test_claim_sizeable_push_msat() {
4832         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4833         let chanmon_cfgs = create_chanmon_cfgs(2);
4834         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4835         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4836         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4837
4838         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4839         nodes[1].node.force_close_channel(&chan.2).unwrap();
4840         check_closed_broadcast!(nodes[1], true);
4841         check_added_monitors!(nodes[1], 1);
4842         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
4843         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4844         assert_eq!(node_txn.len(), 1);
4845         check_spends!(node_txn[0], chan.3);
4846         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
4847
4848         mine_transaction(&nodes[1], &node_txn[0]);
4849         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4850
4851         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4852         assert_eq!(spend_txn.len(), 1);
4853         assert_eq!(spend_txn[0].input.len(), 1);
4854         check_spends!(spend_txn[0], node_txn[0]);
4855         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4856 }
4857
4858 #[test]
4859 fn test_claim_on_remote_sizeable_push_msat() {
4860         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4861         // to_remote output is encumbered by a P2WPKH
4862         let chanmon_cfgs = create_chanmon_cfgs(2);
4863         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4864         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4865         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4866
4867         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4868         nodes[0].node.force_close_channel(&chan.2).unwrap();
4869         check_closed_broadcast!(nodes[0], true);
4870         check_added_monitors!(nodes[0], 1);
4871         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
4872
4873         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4874         assert_eq!(node_txn.len(), 1);
4875         check_spends!(node_txn[0], chan.3);
4876         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
4877
4878         mine_transaction(&nodes[1], &node_txn[0]);
4879         check_closed_broadcast!(nodes[1], true);
4880         check_added_monitors!(nodes[1], 1);
4881         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4882         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4883
4884         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4885         assert_eq!(spend_txn.len(), 1);
4886         check_spends!(spend_txn[0], node_txn[0]);
4887 }
4888
4889 #[test]
4890 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4891         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4892         // to_remote output is encumbered by a P2WPKH
4893
4894         let chanmon_cfgs = create_chanmon_cfgs(2);
4895         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4896         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4897         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4898
4899         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4900         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4901         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4902         assert_eq!(revoked_local_txn[0].input.len(), 1);
4903         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4904
4905         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4906         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4907         check_closed_broadcast!(nodes[1], true);
4908         check_added_monitors!(nodes[1], 1);
4909         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4910
4911         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4912         mine_transaction(&nodes[1], &node_txn[0]);
4913         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4914
4915         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4916         assert_eq!(spend_txn.len(), 3);
4917         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4918         check_spends!(spend_txn[1], node_txn[0]);
4919         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4920 }
4921
4922 #[test]
4923 fn test_static_spendable_outputs_preimage_tx() {
4924         let chanmon_cfgs = create_chanmon_cfgs(2);
4925         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4926         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4927         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4928
4929         // Create some initial channels
4930         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4931
4932         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4933
4934         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4935         assert_eq!(commitment_tx[0].input.len(), 1);
4936         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4937
4938         // Settle A's commitment tx on B's chain
4939         assert!(nodes[1].node.claim_funds(payment_preimage));
4940         check_added_monitors!(nodes[1], 1);
4941         mine_transaction(&nodes[1], &commitment_tx[0]);
4942         check_added_monitors!(nodes[1], 1);
4943         let events = nodes[1].node.get_and_clear_pending_msg_events();
4944         match events[0] {
4945                 MessageSendEvent::UpdateHTLCs { .. } => {},
4946                 _ => panic!("Unexpected event"),
4947         }
4948         match events[1] {
4949                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4950                 _ => panic!("Unexepected event"),
4951         }
4952
4953         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4954         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4955         assert_eq!(node_txn.len(), 3);
4956         check_spends!(node_txn[0], commitment_tx[0]);
4957         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4958         check_spends!(node_txn[1], chan_1.3);
4959         check_spends!(node_txn[2], node_txn[1]);
4960
4961         mine_transaction(&nodes[1], &node_txn[0]);
4962         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4963         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4964
4965         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4966         assert_eq!(spend_txn.len(), 1);
4967         check_spends!(spend_txn[0], node_txn[0]);
4968 }
4969
4970 #[test]
4971 fn test_static_spendable_outputs_timeout_tx() {
4972         let chanmon_cfgs = create_chanmon_cfgs(2);
4973         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4974         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4975         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4976
4977         // Create some initial channels
4978         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4979
4980         // Rebalance the network a bit by relaying one payment through all the channels ...
4981         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4982
4983         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4984
4985         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4986         assert_eq!(commitment_tx[0].input.len(), 1);
4987         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4988
4989         // Settle A's commitment tx on B' chain
4990         mine_transaction(&nodes[1], &commitment_tx[0]);
4991         check_added_monitors!(nodes[1], 1);
4992         let events = nodes[1].node.get_and_clear_pending_msg_events();
4993         match events[0] {
4994                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4995                 _ => panic!("Unexpected event"),
4996         }
4997         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4998
4999         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
5000         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
5001         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
5002         check_spends!(node_txn[0], chan_1.3.clone());
5003         check_spends!(node_txn[1],  commitment_tx[0].clone());
5004         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5005
5006         mine_transaction(&nodes[1], &node_txn[1]);
5007         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5008         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5009         expect_payment_failed!(nodes[1], our_payment_hash, true);
5010
5011         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5012         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
5013         check_spends!(spend_txn[0], commitment_tx[0]);
5014         check_spends!(spend_txn[1], node_txn[1]);
5015         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
5016 }
5017
5018 #[test]
5019 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
5020         let chanmon_cfgs = create_chanmon_cfgs(2);
5021         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5022         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5023         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5024
5025         // Create some initial channels
5026         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5027
5028         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5029         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5030         assert_eq!(revoked_local_txn[0].input.len(), 1);
5031         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5032
5033         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5034
5035         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5036         check_closed_broadcast!(nodes[1], true);
5037         check_added_monitors!(nodes[1], 1);
5038         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5039
5040         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5041         assert_eq!(node_txn.len(), 2);
5042         assert_eq!(node_txn[0].input.len(), 2);
5043         check_spends!(node_txn[0], revoked_local_txn[0]);
5044
5045         mine_transaction(&nodes[1], &node_txn[0]);
5046         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5047
5048         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5049         assert_eq!(spend_txn.len(), 1);
5050         check_spends!(spend_txn[0], node_txn[0]);
5051 }
5052
5053 #[test]
5054 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5055         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5056         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
5057         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5058         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5059         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5060
5061         // Create some initial channels
5062         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5063
5064         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5065         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5066         assert_eq!(revoked_local_txn[0].input.len(), 1);
5067         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5068
5069         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5070
5071         // A will generate HTLC-Timeout from revoked commitment tx
5072         mine_transaction(&nodes[0], &revoked_local_txn[0]);
5073         check_closed_broadcast!(nodes[0], true);
5074         check_added_monitors!(nodes[0], 1);
5075         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5076         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5077
5078         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5079         assert_eq!(revoked_htlc_txn.len(), 2);
5080         check_spends!(revoked_htlc_txn[0], chan_1.3);
5081         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
5082         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5083         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
5084         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
5085
5086         // B will generate justice tx from A's revoked commitment/HTLC tx
5087         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5088         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
5089         check_closed_broadcast!(nodes[1], true);
5090         check_added_monitors!(nodes[1], 1);
5091         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5092
5093         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5094         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5095         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5096         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
5097         // transactions next...
5098         assert_eq!(node_txn[0].input.len(), 3);
5099         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
5100
5101         assert_eq!(node_txn[1].input.len(), 2);
5102         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
5103         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
5104                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5105         } else {
5106                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
5107                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
5108         }
5109
5110         assert_eq!(node_txn[2].input.len(), 1);
5111         check_spends!(node_txn[2], chan_1.3);
5112
5113         mine_transaction(&nodes[1], &node_txn[1]);
5114         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5115
5116         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5117         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5118         assert_eq!(spend_txn.len(), 1);
5119         assert_eq!(spend_txn[0].input.len(), 1);
5120         check_spends!(spend_txn[0], node_txn[1]);
5121 }
5122
5123 #[test]
5124 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5125         let mut chanmon_cfgs = create_chanmon_cfgs(2);
5126         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
5127         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5128         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5129         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5130
5131         // Create some initial channels
5132         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5133
5134         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5135         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5136         assert_eq!(revoked_local_txn[0].input.len(), 1);
5137         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5138
5139         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5140         assert_eq!(revoked_local_txn[0].output.len(), 2);
5141
5142         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
5143
5144         // B will generate HTLC-Success from revoked commitment tx
5145         mine_transaction(&nodes[1], &revoked_local_txn[0]);
5146         check_closed_broadcast!(nodes[1], true);
5147         check_added_monitors!(nodes[1], 1);
5148         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5149         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5150
5151         assert_eq!(revoked_htlc_txn.len(), 2);
5152         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5153         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5154         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5155
5156         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5157         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5158         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5159
5160         // A will generate justice tx from B's revoked commitment/HTLC tx
5161         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5162         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
5163         check_closed_broadcast!(nodes[0], true);
5164         check_added_monitors!(nodes[0], 1);
5165         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5166
5167         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5168         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5169
5170         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5171         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5172         // transactions next...
5173         assert_eq!(node_txn[0].input.len(), 2);
5174         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5175         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5176                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5177         } else {
5178                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5179                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5180         }
5181
5182         assert_eq!(node_txn[1].input.len(), 1);
5183         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5184
5185         check_spends!(node_txn[2], chan_1.3);
5186
5187         mine_transaction(&nodes[0], &node_txn[1]);
5188         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5189
5190         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5191         // didn't try to generate any new transactions.
5192
5193         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5194         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5195         assert_eq!(spend_txn.len(), 3);
5196         assert_eq!(spend_txn[0].input.len(), 1);
5197         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5198         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5199         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
5200         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5201 }
5202
5203 #[test]
5204 fn test_onchain_to_onchain_claim() {
5205         // Test that in case of channel closure, we detect the state of output and claim HTLC
5206         // on downstream peer's remote commitment tx.
5207         // First, have C claim an HTLC against its own latest commitment transaction.
5208         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5209         // channel.
5210         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5211         // gets broadcast.
5212
5213         let chanmon_cfgs = create_chanmon_cfgs(3);
5214         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5215         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5216         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5217
5218         // Create some initial channels
5219         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5220         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5221
5222         // Ensure all nodes are at the same height
5223         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5224         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5225         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5226         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5227
5228         // Rebalance the network a bit by relaying one payment through all the channels ...
5229         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5230         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5231
5232         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5233         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5234         check_spends!(commitment_tx[0], chan_2.3);
5235         nodes[2].node.claim_funds(payment_preimage);
5236         check_added_monitors!(nodes[2], 1);
5237         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5238         assert!(updates.update_add_htlcs.is_empty());
5239         assert!(updates.update_fail_htlcs.is_empty());
5240         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5241         assert!(updates.update_fail_malformed_htlcs.is_empty());
5242
5243         mine_transaction(&nodes[2], &commitment_tx[0]);
5244         check_closed_broadcast!(nodes[2], true);
5245         check_added_monitors!(nodes[2], 1);
5246         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
5247
5248         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5249         assert_eq!(c_txn.len(), 3);
5250         assert_eq!(c_txn[0], c_txn[2]);
5251         assert_eq!(commitment_tx[0], c_txn[1]);
5252         check_spends!(c_txn[1], chan_2.3);
5253         check_spends!(c_txn[2], c_txn[1]);
5254         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5255         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5256         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5257         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5258
5259         // 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
5260         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5261         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5262         check_added_monitors!(nodes[1], 1);
5263         let events = nodes[1].node.get_and_clear_pending_events();
5264         assert_eq!(events.len(), 2);
5265         match events[0] {
5266                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
5267                 _ => panic!("Unexpected event"),
5268         }
5269         match events[1] {
5270                 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
5271                         assert_eq!(fee_earned_msat, Some(1000));
5272                         assert_eq!(claim_from_onchain_tx, true);
5273                 },
5274                 _ => panic!("Unexpected event"),
5275         }
5276         {
5277                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5278                 // ChannelMonitor: claim tx
5279                 assert_eq!(b_txn.len(), 1);
5280                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5281                 b_txn.clear();
5282         }
5283         check_added_monitors!(nodes[1], 1);
5284         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5285         assert_eq!(msg_events.len(), 3);
5286         match msg_events[0] {
5287                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5288                 _ => panic!("Unexpected event"),
5289         }
5290         match msg_events[1] {
5291                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5292                 _ => panic!("Unexpected event"),
5293         }
5294         match msg_events[2] {
5295                 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, .. } } => {
5296                         assert!(update_add_htlcs.is_empty());
5297                         assert!(update_fail_htlcs.is_empty());
5298                         assert_eq!(update_fulfill_htlcs.len(), 1);
5299                         assert!(update_fail_malformed_htlcs.is_empty());
5300                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5301                 },
5302                 _ => panic!("Unexpected event"),
5303         };
5304         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5305         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5306         mine_transaction(&nodes[1], &commitment_tx[0]);
5307         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5308         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5309         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5310         assert_eq!(b_txn.len(), 3);
5311         check_spends!(b_txn[1], chan_1.3);
5312         check_spends!(b_txn[2], b_txn[1]);
5313         check_spends!(b_txn[0], commitment_tx[0]);
5314         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5315         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5316         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5317
5318         check_closed_broadcast!(nodes[1], true);
5319         check_added_monitors!(nodes[1], 1);
5320 }
5321
5322 #[test]
5323 fn test_duplicate_payment_hash_one_failure_one_success() {
5324         // Topology : A --> B --> C --> D
5325         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5326         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5327         // we forward one of the payments onwards to D.
5328         let chanmon_cfgs = create_chanmon_cfgs(4);
5329         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5330         // When this test was written, the default base fee floated based on the HTLC count.
5331         // It is now fixed, so we simply set the fee to the expected value here.
5332         let mut config = test_default_channel_config();
5333         config.channel_options.forwarding_fee_base_msat = 196;
5334         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5335                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5336         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5337
5338         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5339         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5340         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5341
5342         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5343         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5344         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5345         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5346         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5347
5348         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5349
5350         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5351         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5352         // script push size limit so that the below script length checks match
5353         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5354         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
5355                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5356         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5357
5358         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5359         assert_eq!(commitment_txn[0].input.len(), 1);
5360         check_spends!(commitment_txn[0], chan_2.3);
5361
5362         mine_transaction(&nodes[1], &commitment_txn[0]);
5363         check_closed_broadcast!(nodes[1], true);
5364         check_added_monitors!(nodes[1], 1);
5365         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5366         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5367
5368         let htlc_timeout_tx;
5369         { // Extract one of the two HTLC-Timeout transaction
5370                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5371                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5372                 assert_eq!(node_txn.len(), 4);
5373                 check_spends!(node_txn[0], chan_2.3);
5374
5375                 check_spends!(node_txn[1], commitment_txn[0]);
5376                 assert_eq!(node_txn[1].input.len(), 1);
5377                 check_spends!(node_txn[2], commitment_txn[0]);
5378                 assert_eq!(node_txn[2].input.len(), 1);
5379                 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5380                 check_spends!(node_txn[3], commitment_txn[0]);
5381                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5382
5383                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5384                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5385                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5386                 htlc_timeout_tx = node_txn[1].clone();
5387         }
5388
5389         nodes[2].node.claim_funds(our_payment_preimage);
5390         mine_transaction(&nodes[2], &commitment_txn[0]);
5391         check_added_monitors!(nodes[2], 2);
5392         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
5393         let events = nodes[2].node.get_and_clear_pending_msg_events();
5394         match events[0] {
5395                 MessageSendEvent::UpdateHTLCs { .. } => {},
5396                 _ => panic!("Unexpected event"),
5397         }
5398         match events[1] {
5399                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5400                 _ => panic!("Unexepected event"),
5401         }
5402         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5403         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)
5404         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5405         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5406         assert_eq!(htlc_success_txn[0].input.len(), 1);
5407         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5408         assert_eq!(htlc_success_txn[1].input.len(), 1);
5409         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5410         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5411         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5412         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5413         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5414         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5415
5416         mine_transaction(&nodes[1], &htlc_timeout_tx);
5417         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5418         expect_pending_htlcs_forwardable!(nodes[1]);
5419         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5420         assert!(htlc_updates.update_add_htlcs.is_empty());
5421         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5422         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5423         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5424         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5425         check_added_monitors!(nodes[1], 1);
5426
5427         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5428         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5429         {
5430                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5431         }
5432         expect_payment_failed_with_update!(nodes[0], duplicate_payment_hash, false, chan_2.0.contents.short_channel_id, true);
5433
5434         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5435         // Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
5436         // and nodes[2] fee) is rounded down and then claimed in full.
5437         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5438         expect_payment_forwarded!(nodes[1], Some(196*2), true);
5439         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5440         assert!(updates.update_add_htlcs.is_empty());
5441         assert!(updates.update_fail_htlcs.is_empty());
5442         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5443         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5444         assert!(updates.update_fail_malformed_htlcs.is_empty());
5445         check_added_monitors!(nodes[1], 1);
5446
5447         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5448         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5449
5450         let events = nodes[0].node.get_and_clear_pending_events();
5451         match events[0] {
5452                 Event::PaymentSent { ref payment_preimage } => {
5453                         assert_eq!(*payment_preimage, our_payment_preimage);
5454                 }
5455                 _ => panic!("Unexpected event"),
5456         }
5457 }
5458
5459 #[test]
5460 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5461         let chanmon_cfgs = create_chanmon_cfgs(2);
5462         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5463         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5464         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5465
5466         // Create some initial channels
5467         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5468
5469         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5470         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5471         assert_eq!(local_txn.len(), 1);
5472         assert_eq!(local_txn[0].input.len(), 1);
5473         check_spends!(local_txn[0], chan_1.3);
5474
5475         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5476         nodes[1].node.claim_funds(payment_preimage);
5477         check_added_monitors!(nodes[1], 1);
5478         mine_transaction(&nodes[1], &local_txn[0]);
5479         check_added_monitors!(nodes[1], 1);
5480         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5481         let events = nodes[1].node.get_and_clear_pending_msg_events();
5482         match events[0] {
5483                 MessageSendEvent::UpdateHTLCs { .. } => {},
5484                 _ => panic!("Unexpected event"),
5485         }
5486         match events[1] {
5487                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5488                 _ => panic!("Unexepected event"),
5489         }
5490         let node_tx = {
5491                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5492                 assert_eq!(node_txn.len(), 3);
5493                 assert_eq!(node_txn[0], node_txn[2]);
5494                 assert_eq!(node_txn[1], local_txn[0]);
5495                 assert_eq!(node_txn[0].input.len(), 1);
5496                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5497                 check_spends!(node_txn[0], local_txn[0]);
5498                 node_txn[0].clone()
5499         };
5500
5501         mine_transaction(&nodes[1], &node_tx);
5502         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5503
5504         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5505         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5506         assert_eq!(spend_txn.len(), 1);
5507         assert_eq!(spend_txn[0].input.len(), 1);
5508         check_spends!(spend_txn[0], node_tx);
5509         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5510 }
5511
5512 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5513         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5514         // unrevoked commitment transaction.
5515         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5516         // a remote RAA before they could be failed backwards (and combinations thereof).
5517         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5518         // use the same payment hashes.
5519         // Thus, we use a six-node network:
5520         //
5521         // A \         / E
5522         //    - C - D -
5523         // B /         \ F
5524         // And test where C fails back to A/B when D announces its latest commitment transaction
5525         let chanmon_cfgs = create_chanmon_cfgs(6);
5526         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5527         // When this test was written, the default base fee floated based on the HTLC count.
5528         // It is now fixed, so we simply set the fee to the expected value here.
5529         let mut config = test_default_channel_config();
5530         config.channel_options.forwarding_fee_base_msat = 196;
5531         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5532                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5533         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5534         let logger = test_utils::TestLogger::new();
5535
5536         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5537         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5538         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5539         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5540         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5541
5542         // Rebalance and check output sanity...
5543         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5544         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5545         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5546
5547         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5548         // 0th HTLC:
5549         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
5550         // 1st HTLC:
5551         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], ds_dust_limit*1000); // not added < dust limit + HTLC tx fee
5552         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5553         let our_node_id = &nodes[1].node.get_our_node_id();
5554         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5555         // 2nd HTLC:
5556         send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_1, nodes[5].node.create_inbound_payment_for_hash(payment_hash_1, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5557         // 3rd HTLC:
5558         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_2, nodes[5].node.create_inbound_payment_for_hash(payment_hash_2, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5559         // 4th HTLC:
5560         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5561         // 5th HTLC:
5562         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5563         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5564         // 6th HTLC:
5565         send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_3, nodes[5].node.create_inbound_payment_for_hash(payment_hash_3, None, 7200, 0).unwrap());
5566         // 7th HTLC:
5567         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_4, nodes[5].node.create_inbound_payment_for_hash(payment_hash_4, None, 7200, 0).unwrap());
5568
5569         // 8th HTLC:
5570         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5571         // 9th HTLC:
5572         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5573         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_5, nodes[5].node.create_inbound_payment_for_hash(payment_hash_5, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5574
5575         // 10th HTLC:
5576         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
5577         // 11th HTLC:
5578         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph, &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5579         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_6, nodes[5].node.create_inbound_payment_for_hash(payment_hash_6, None, 7200, 0).unwrap());
5580
5581         // Double-check that six of the new HTLC were added
5582         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5583         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5584         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5585         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5586
5587         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5588         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5589         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5590         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5591         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5592         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5593         check_added_monitors!(nodes[4], 0);
5594         expect_pending_htlcs_forwardable!(nodes[4]);
5595         check_added_monitors!(nodes[4], 1);
5596
5597         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5598         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5599         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5600         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5601         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5602         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5603
5604         // Fail 3rd below-dust and 7th above-dust HTLCs
5605         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5606         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5607         check_added_monitors!(nodes[5], 0);
5608         expect_pending_htlcs_forwardable!(nodes[5]);
5609         check_added_monitors!(nodes[5], 1);
5610
5611         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5612         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5613         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5614         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5615
5616         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5617
5618         expect_pending_htlcs_forwardable!(nodes[3]);
5619         check_added_monitors!(nodes[3], 1);
5620         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5621         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5622         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5623         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5624         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5625         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5626         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5627         if deliver_last_raa {
5628                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5629         } else {
5630                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5631         }
5632
5633         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5634         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5635         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5636         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5637         //
5638         // We now broadcast the latest commitment transaction, which *should* result in failures for
5639         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5640         // the non-broadcast above-dust HTLCs.
5641         //
5642         // Alternatively, we may broadcast the previous commitment transaction, which should only
5643         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5644         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5645
5646         if announce_latest {
5647                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5648         } else {
5649                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5650         }
5651         let events = nodes[2].node.get_and_clear_pending_events();
5652         let close_event = if deliver_last_raa {
5653                 assert_eq!(events.len(), 2);
5654                 events[1].clone()
5655         } else {
5656                 assert_eq!(events.len(), 1);
5657                 events[0].clone()
5658         };
5659         match close_event {
5660                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
5661                 _ => panic!("Unexpected event"),
5662         }
5663
5664         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5665         check_closed_broadcast!(nodes[2], true);
5666         if deliver_last_raa {
5667                 expect_pending_htlcs_forwardable_from_events!(nodes[2], events[0..1], true);
5668         } else {
5669                 expect_pending_htlcs_forwardable!(nodes[2]);
5670         }
5671         check_added_monitors!(nodes[2], 3);
5672
5673         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5674         assert_eq!(cs_msgs.len(), 2);
5675         let mut a_done = false;
5676         for msg in cs_msgs {
5677                 match msg {
5678                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5679                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5680                                 // should be failed-backwards here.
5681                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5682                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5683                                         for htlc in &updates.update_fail_htlcs {
5684                                                 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 });
5685                                         }
5686                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5687                                         assert!(!a_done);
5688                                         a_done = true;
5689                                         &nodes[0]
5690                                 } else {
5691                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5692                                         for htlc in &updates.update_fail_htlcs {
5693                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5694                                         }
5695                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5696                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5697                                         &nodes[1]
5698                                 };
5699                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5700                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5701                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5702                                 if announce_latest {
5703                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5704                                         if *node_id == nodes[0].node.get_our_node_id() {
5705                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5706                                         }
5707                                 }
5708                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5709                         },
5710                         _ => panic!("Unexpected event"),
5711                 }
5712         }
5713
5714         let as_events = nodes[0].node.get_and_clear_pending_events();
5715         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5716         let mut as_failds = HashSet::new();
5717         let mut as_updates = 0;
5718         for event in as_events.iter() {
5719                 if let &Event::PaymentPathFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5720                         assert!(as_failds.insert(*payment_hash));
5721                         if *payment_hash != payment_hash_2 {
5722                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5723                         } else {
5724                                 assert!(!rejected_by_dest);
5725                         }
5726                         if network_update.is_some() {
5727                                 as_updates += 1;
5728                         }
5729                 } else { panic!("Unexpected event"); }
5730         }
5731         assert!(as_failds.contains(&payment_hash_1));
5732         assert!(as_failds.contains(&payment_hash_2));
5733         if announce_latest {
5734                 assert!(as_failds.contains(&payment_hash_3));
5735                 assert!(as_failds.contains(&payment_hash_5));
5736         }
5737         assert!(as_failds.contains(&payment_hash_6));
5738
5739         let bs_events = nodes[1].node.get_and_clear_pending_events();
5740         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5741         let mut bs_failds = HashSet::new();
5742         let mut bs_updates = 0;
5743         for event in bs_events.iter() {
5744                 if let &Event::PaymentPathFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5745                         assert!(bs_failds.insert(*payment_hash));
5746                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5747                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5748                         } else {
5749                                 assert!(!rejected_by_dest);
5750                         }
5751                         if network_update.is_some() {
5752                                 bs_updates += 1;
5753                         }
5754                 } else { panic!("Unexpected event"); }
5755         }
5756         assert!(bs_failds.contains(&payment_hash_1));
5757         assert!(bs_failds.contains(&payment_hash_2));
5758         if announce_latest {
5759                 assert!(bs_failds.contains(&payment_hash_4));
5760         }
5761         assert!(bs_failds.contains(&payment_hash_5));
5762
5763         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5764         // get a NetworkUpdate. A should have gotten 4 HTLCs which were failed-back due to
5765         // unknown-preimage-etc, B should have gotten 2. Thus, in the
5766         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2 NetworkUpdates.
5767         assert_eq!(as_updates, if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5768         assert_eq!(bs_updates, if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5769 }
5770
5771 #[test]
5772 fn test_fail_backwards_latest_remote_announce_a() {
5773         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5774 }
5775
5776 #[test]
5777 fn test_fail_backwards_latest_remote_announce_b() {
5778         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5779 }
5780
5781 #[test]
5782 fn test_fail_backwards_previous_remote_announce() {
5783         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5784         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5785         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5786 }
5787
5788 #[test]
5789 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5790         let chanmon_cfgs = create_chanmon_cfgs(2);
5791         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5792         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5793         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5794
5795         // Create some initial channels
5796         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5797
5798         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5799         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5800         assert_eq!(local_txn[0].input.len(), 1);
5801         check_spends!(local_txn[0], chan_1.3);
5802
5803         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5804         mine_transaction(&nodes[0], &local_txn[0]);
5805         check_closed_broadcast!(nodes[0], true);
5806         check_added_monitors!(nodes[0], 1);
5807         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5808         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5809
5810         let htlc_timeout = {
5811                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5812                 assert_eq!(node_txn.len(), 2);
5813                 check_spends!(node_txn[0], chan_1.3);
5814                 assert_eq!(node_txn[1].input.len(), 1);
5815                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5816                 check_spends!(node_txn[1], local_txn[0]);
5817                 node_txn[1].clone()
5818         };
5819
5820         mine_transaction(&nodes[0], &htlc_timeout);
5821         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5822         expect_payment_failed!(nodes[0], our_payment_hash, true);
5823
5824         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5825         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5826         assert_eq!(spend_txn.len(), 3);
5827         check_spends!(spend_txn[0], local_txn[0]);
5828         assert_eq!(spend_txn[1].input.len(), 1);
5829         check_spends!(spend_txn[1], htlc_timeout);
5830         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5831         assert_eq!(spend_txn[2].input.len(), 2);
5832         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5833         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5834                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5835 }
5836
5837 #[test]
5838 fn test_key_derivation_params() {
5839         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5840         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5841         // let us re-derive the channel key set to then derive a delayed_payment_key.
5842
5843         let chanmon_cfgs = create_chanmon_cfgs(3);
5844
5845         // We manually create the node configuration to backup the seed.
5846         let seed = [42; 32];
5847         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5848         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);
5849         let node = NodeCfg { chain_source: &chanmon_cfgs[0].chain_source, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, chain_monitor, keys_manager: &keys_manager, node_seed: seed, features: InitFeatures::known() };
5850         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5851         node_cfgs.remove(0);
5852         node_cfgs.insert(0, node);
5853
5854         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5855         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5856
5857         // Create some initial channels
5858         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5859         // for node 0
5860         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5861         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5862         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5863
5864         // Ensure all nodes are at the same height
5865         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5866         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5867         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5868         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5869
5870         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5871         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5872         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5873         assert_eq!(local_txn_1[0].input.len(), 1);
5874         check_spends!(local_txn_1[0], chan_1.3);
5875
5876         // We check funding pubkey are unique
5877         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]));
5878         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]));
5879         if from_0_funding_key_0 == from_1_funding_key_0
5880             || from_0_funding_key_0 == from_1_funding_key_1
5881             || from_0_funding_key_1 == from_1_funding_key_0
5882             || from_0_funding_key_1 == from_1_funding_key_1 {
5883                 panic!("Funding pubkeys aren't unique");
5884         }
5885
5886         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5887         mine_transaction(&nodes[0], &local_txn_1[0]);
5888         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5889         check_closed_broadcast!(nodes[0], true);
5890         check_added_monitors!(nodes[0], 1);
5891         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5892
5893         let htlc_timeout = {
5894                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5895                 assert_eq!(node_txn[1].input.len(), 1);
5896                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5897                 check_spends!(node_txn[1], local_txn_1[0]);
5898                 node_txn[1].clone()
5899         };
5900
5901         mine_transaction(&nodes[0], &htlc_timeout);
5902         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5903         expect_payment_failed!(nodes[0], our_payment_hash, true);
5904
5905         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5906         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5907         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5908         assert_eq!(spend_txn.len(), 3);
5909         check_spends!(spend_txn[0], local_txn_1[0]);
5910         assert_eq!(spend_txn[1].input.len(), 1);
5911         check_spends!(spend_txn[1], htlc_timeout);
5912         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5913         assert_eq!(spend_txn[2].input.len(), 2);
5914         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5915         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5916                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5917 }
5918
5919 #[test]
5920 fn test_static_output_closing_tx() {
5921         let chanmon_cfgs = create_chanmon_cfgs(2);
5922         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5923         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5924         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5925
5926         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5927
5928         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5929         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5930
5931         mine_transaction(&nodes[0], &closing_tx);
5932         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
5933         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5934
5935         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5936         assert_eq!(spend_txn.len(), 1);
5937         check_spends!(spend_txn[0], closing_tx);
5938
5939         mine_transaction(&nodes[1], &closing_tx);
5940         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
5941         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5942
5943         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5944         assert_eq!(spend_txn.len(), 1);
5945         check_spends!(spend_txn[0], closing_tx);
5946 }
5947
5948 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5949         let chanmon_cfgs = create_chanmon_cfgs(2);
5950         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5951         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5952         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5953         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5954
5955         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5956
5957         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5958         // present in B's local commitment transaction, but none of A's commitment transactions.
5959         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5960         check_added_monitors!(nodes[1], 1);
5961
5962         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5963         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5964         let events = nodes[0].node.get_and_clear_pending_events();
5965         assert_eq!(events.len(), 1);
5966         match events[0] {
5967                 Event::PaymentSent { payment_preimage } => {
5968                         assert_eq!(payment_preimage, our_payment_preimage);
5969                 },
5970                 _ => panic!("Unexpected event"),
5971         }
5972
5973         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5974         check_added_monitors!(nodes[0], 1);
5975         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5976         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5977         check_added_monitors!(nodes[1], 1);
5978
5979         let starting_block = nodes[1].best_block_info();
5980         let mut block = Block {
5981                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5982                 txdata: vec![],
5983         };
5984         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5985                 connect_block(&nodes[1], &block);
5986                 block.header.prev_blockhash = block.block_hash();
5987         }
5988         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5989         check_closed_broadcast!(nodes[1], true);
5990         check_added_monitors!(nodes[1], 1);
5991         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5992 }
5993
5994 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5995         let chanmon_cfgs = create_chanmon_cfgs(2);
5996         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5997         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5998         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5999         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6000         let logger = test_utils::TestLogger::new();
6001
6002         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
6003         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6004         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
6005         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
6006         check_added_monitors!(nodes[0], 1);
6007
6008         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6009
6010         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
6011         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
6012         // to "time out" the HTLC.
6013
6014         let starting_block = nodes[1].best_block_info();
6015         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6016
6017         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
6018                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
6019                 header.prev_blockhash = header.block_hash();
6020         }
6021         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6022         check_closed_broadcast!(nodes[0], true);
6023         check_added_monitors!(nodes[0], 1);
6024         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6025 }
6026
6027 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
6028         let chanmon_cfgs = create_chanmon_cfgs(3);
6029         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6030         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6031         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6032         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6033
6034         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
6035         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
6036         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
6037         // actually revoked.
6038         let htlc_value = if use_dust { 50000 } else { 3000000 };
6039         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
6040         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
6041         expect_pending_htlcs_forwardable!(nodes[1]);
6042         check_added_monitors!(nodes[1], 1);
6043
6044         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6045         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
6046         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
6047         check_added_monitors!(nodes[0], 1);
6048         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6049         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
6050         check_added_monitors!(nodes[1], 1);
6051         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
6052         check_added_monitors!(nodes[1], 1);
6053         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6054
6055         if check_revoke_no_close {
6056                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
6057                 check_added_monitors!(nodes[0], 1);
6058         }
6059
6060         let starting_block = nodes[1].best_block_info();
6061         let mut block = Block {
6062                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6063                 txdata: vec![],
6064         };
6065         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
6066                 connect_block(&nodes[0], &block);
6067                 block.header.prev_blockhash = block.block_hash();
6068         }
6069         if !check_revoke_no_close {
6070                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
6071                 check_closed_broadcast!(nodes[0], true);
6072                 check_added_monitors!(nodes[0], 1);
6073                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6074         } else {
6075                 expect_payment_failed!(nodes[0], our_payment_hash, true);
6076         }
6077 }
6078
6079 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
6080 // There are only a few cases to test here:
6081 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
6082 //    broadcastable commitment transactions result in channel closure,
6083 //  * its included in an unrevoked-but-previous remote commitment transaction,
6084 //  * its included in the latest remote or local commitment transactions.
6085 // We test each of the three possible commitment transactions individually and use both dust and
6086 // non-dust HTLCs.
6087 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
6088 // assume they are handled the same across all six cases, as both outbound and inbound failures are
6089 // tested for at least one of the cases in other tests.
6090 #[test]
6091 fn htlc_claim_single_commitment_only_a() {
6092         do_htlc_claim_local_commitment_only(true);
6093         do_htlc_claim_local_commitment_only(false);
6094
6095         do_htlc_claim_current_remote_commitment_only(true);
6096         do_htlc_claim_current_remote_commitment_only(false);
6097 }
6098
6099 #[test]
6100 fn htlc_claim_single_commitment_only_b() {
6101         do_htlc_claim_previous_remote_commitment_only(true, false);
6102         do_htlc_claim_previous_remote_commitment_only(false, false);
6103         do_htlc_claim_previous_remote_commitment_only(true, true);
6104         do_htlc_claim_previous_remote_commitment_only(false, true);
6105 }
6106
6107 #[test]
6108 #[should_panic]
6109 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6110         let chanmon_cfgs = create_chanmon_cfgs(2);
6111         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6112         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6113         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6114         //Force duplicate channel ids
6115         for node in nodes.iter() {
6116                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6117         }
6118
6119         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6120         let channel_value_satoshis=10000;
6121         let push_msat=10001;
6122         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6123         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6124         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6125
6126         //Create a second channel with a channel_id collision
6127         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6128 }
6129
6130 #[test]
6131 fn bolt2_open_channel_sending_node_checks_part2() {
6132         let chanmon_cfgs = create_chanmon_cfgs(2);
6133         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6134         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6135         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6136
6137         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6138         let channel_value_satoshis=2^24;
6139         let push_msat=10001;
6140         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6141
6142         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6143         let channel_value_satoshis=10000;
6144         // Test when push_msat is equal to 1000 * funding_satoshis.
6145         let push_msat=1000*channel_value_satoshis+1;
6146         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6147
6148         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6149         let channel_value_satoshis=10000;
6150         let push_msat=10001;
6151         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
6152         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6153         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6154
6155         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6156         // 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
6157         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6158
6159         // 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.
6160         assert!(BREAKDOWN_TIMEOUT>0);
6161         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6162
6163         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6164         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6165         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6166
6167         // 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.
6168         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6169         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6170         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6171         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6172         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6173 }
6174
6175 #[test]
6176 fn bolt2_open_channel_sane_dust_limit() {
6177         let chanmon_cfgs = create_chanmon_cfgs(2);
6178         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6179         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6180         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6181
6182         let channel_value_satoshis=1000000;
6183         let push_msat=10001;
6184         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6185         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6186         node0_to_1_send_open_channel.dust_limit_satoshis = 547;
6187         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
6188
6189         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6190         let events = nodes[1].node.get_and_clear_pending_msg_events();
6191         let err_msg = match events[0] {
6192                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
6193                         msg.clone()
6194                 },
6195                 _ => panic!("Unexpected event"),
6196         };
6197         assert_eq!(err_msg.data, "dust_limit_satoshis (547) is greater than the implementation limit (546)");
6198 }
6199
6200 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6201 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6202 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6203 // is no longer affordable once it's freed.
6204 #[test]
6205 fn test_fail_holding_cell_htlc_upon_free() {
6206         let chanmon_cfgs = create_chanmon_cfgs(2);
6207         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6208         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6209         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6210         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6211         let logger = test_utils::TestLogger::new();
6212
6213         // First nodes[0] generates an update_fee, setting the channel's
6214         // pending_update_fee.
6215         {
6216                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
6217                 *feerate_lock += 20;
6218         }
6219         nodes[0].node.timer_tick_occurred();
6220         check_added_monitors!(nodes[0], 1);
6221
6222         let events = nodes[0].node.get_and_clear_pending_msg_events();
6223         assert_eq!(events.len(), 1);
6224         let (update_msg, commitment_signed) = match events[0] {
6225                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6226                         (update_fee.as_ref(), commitment_signed)
6227                 },
6228                 _ => panic!("Unexpected event"),
6229         };
6230
6231         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6232
6233         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6234         let channel_reserve = chan_stat.channel_reserve_msat;
6235         let feerate = get_feerate!(nodes[0], chan.2);
6236
6237         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6238         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6239         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6240         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6241         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6242
6243         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6244         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6245         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6246         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6247
6248         // Flush the pending fee update.
6249         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6250         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6251         check_added_monitors!(nodes[1], 1);
6252         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6253         check_added_monitors!(nodes[0], 1);
6254
6255         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6256         // HTLC, but now that the fee has been raised the payment will now fail, causing
6257         // us to surface its failure to the user.
6258         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6259         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6260         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Freeing holding cell with 1 HTLC updates in channel {}", hex::encode(chan.2)), 1);
6261         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({}) in channel {}",
6262                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6263         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6264
6265         // Check that the payment failed to be sent out.
6266         let events = nodes[0].node.get_and_clear_pending_events();
6267         assert_eq!(events.len(), 1);
6268         match &events[0] {
6269                 &Event::PaymentPathFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed, path: _ } => {
6270                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6271                         assert_eq!(*rejected_by_dest, false);
6272                         assert_eq!(*all_paths_failed, true);
6273                         assert_eq!(*network_update, None);
6274                         assert_eq!(*error_code, None);
6275                         assert_eq!(*error_data, None);
6276                 },
6277                 _ => panic!("Unexpected event"),
6278         }
6279 }
6280
6281 // Test that if multiple HTLCs are released from the holding cell and one is
6282 // valid but the other is no longer valid upon release, the valid HTLC can be
6283 // successfully completed while the other one fails as expected.
6284 #[test]
6285 fn test_free_and_fail_holding_cell_htlcs() {
6286         let chanmon_cfgs = create_chanmon_cfgs(2);
6287         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6288         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6289         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6290         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6291         let logger = test_utils::TestLogger::new();
6292
6293         // First nodes[0] generates an update_fee, setting the channel's
6294         // pending_update_fee.
6295         {
6296                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
6297                 *feerate_lock += 200;
6298         }
6299         nodes[0].node.timer_tick_occurred();
6300         check_added_monitors!(nodes[0], 1);
6301
6302         let events = nodes[0].node.get_and_clear_pending_msg_events();
6303         assert_eq!(events.len(), 1);
6304         let (update_msg, commitment_signed) = match events[0] {
6305                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6306                         (update_fee.as_ref(), commitment_signed)
6307                 },
6308                 _ => panic!("Unexpected event"),
6309         };
6310
6311         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6312
6313         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6314         let channel_reserve = chan_stat.channel_reserve_msat;
6315         let feerate = get_feerate!(nodes[0], chan.2);
6316
6317         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6318         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6319         let amt_1 = 20000;
6320         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6321         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6322         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6323         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6324         let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6325
6326         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6327         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6328         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6329         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6330         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6331         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6332         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6333
6334         // Flush the pending fee update.
6335         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6336         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6337         check_added_monitors!(nodes[1], 1);
6338         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6339         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6340         check_added_monitors!(nodes[0], 2);
6341
6342         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6343         // but now that the fee has been raised the second payment will now fail, causing us
6344         // to surface its failure to the user. The first payment should succeed.
6345         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6346         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6347         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Freeing holding cell with 2 HTLC updates in channel {}", hex::encode(chan.2)), 1);
6348         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({}) in channel {}",
6349                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6350         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6351
6352         // Check that the second payment failed to be sent out.
6353         let events = nodes[0].node.get_and_clear_pending_events();
6354         assert_eq!(events.len(), 1);
6355         match &events[0] {
6356                 &Event::PaymentPathFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed, path: _ } => {
6357                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6358                         assert_eq!(*rejected_by_dest, false);
6359                         assert_eq!(*all_paths_failed, true);
6360                         assert_eq!(*network_update, None);
6361                         assert_eq!(*error_code, None);
6362                         assert_eq!(*error_data, None);
6363                 },
6364                 _ => panic!("Unexpected event"),
6365         }
6366
6367         // Complete the first payment and the RAA from the fee update.
6368         let (payment_event, send_raa_event) = {
6369                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6370                 assert_eq!(msgs.len(), 2);
6371                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6372         };
6373         let raa = match send_raa_event {
6374                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6375                 _ => panic!("Unexpected event"),
6376         };
6377         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6378         check_added_monitors!(nodes[1], 1);
6379         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6380         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6381         let events = nodes[1].node.get_and_clear_pending_events();
6382         assert_eq!(events.len(), 1);
6383         match events[0] {
6384                 Event::PendingHTLCsForwardable { .. } => {},
6385                 _ => panic!("Unexpected event"),
6386         }
6387         nodes[1].node.process_pending_htlc_forwards();
6388         let events = nodes[1].node.get_and_clear_pending_events();
6389         assert_eq!(events.len(), 1);
6390         match events[0] {
6391                 Event::PaymentReceived { .. } => {},
6392                 _ => panic!("Unexpected event"),
6393         }
6394         nodes[1].node.claim_funds(payment_preimage_1);
6395         check_added_monitors!(nodes[1], 1);
6396         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6397         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6398         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6399         let events = nodes[0].node.get_and_clear_pending_events();
6400         assert_eq!(events.len(), 1);
6401         match events[0] {
6402                 Event::PaymentSent { ref payment_preimage } => {
6403                         assert_eq!(*payment_preimage, payment_preimage_1);
6404                 }
6405                 _ => panic!("Unexpected event"),
6406         }
6407 }
6408
6409 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6410 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6411 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6412 // once it's freed.
6413 #[test]
6414 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6415         let chanmon_cfgs = create_chanmon_cfgs(3);
6416         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6417         // When this test was written, the default base fee floated based on the HTLC count.
6418         // It is now fixed, so we simply set the fee to the expected value here.
6419         let mut config = test_default_channel_config();
6420         config.channel_options.forwarding_fee_base_msat = 196;
6421         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6422         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6423         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6424         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6425         let logger = test_utils::TestLogger::new();
6426
6427         // First nodes[1] generates an update_fee, setting the channel's
6428         // pending_update_fee.
6429         {
6430                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
6431                 *feerate_lock += 20;
6432         }
6433         nodes[1].node.timer_tick_occurred();
6434         check_added_monitors!(nodes[1], 1);
6435
6436         let events = nodes[1].node.get_and_clear_pending_msg_events();
6437         assert_eq!(events.len(), 1);
6438         let (update_msg, commitment_signed) = match events[0] {
6439                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6440                         (update_fee.as_ref(), commitment_signed)
6441                 },
6442                 _ => panic!("Unexpected event"),
6443         };
6444
6445         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6446
6447         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6448         let channel_reserve = chan_stat.channel_reserve_msat;
6449         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6450
6451         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6452         let feemsat = 239;
6453         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6454         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6455         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6456         let payment_event = {
6457                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6458                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6459                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6460                 check_added_monitors!(nodes[0], 1);
6461
6462                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6463                 assert_eq!(events.len(), 1);
6464
6465                 SendEvent::from_event(events.remove(0))
6466         };
6467         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6468         check_added_monitors!(nodes[1], 0);
6469         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6470         expect_pending_htlcs_forwardable!(nodes[1]);
6471
6472         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6473         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6474
6475         // Flush the pending fee update.
6476         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6477         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6478         check_added_monitors!(nodes[2], 1);
6479         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6480         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6481         check_added_monitors!(nodes[1], 2);
6482
6483         // A final RAA message is generated to finalize the fee update.
6484         let events = nodes[1].node.get_and_clear_pending_msg_events();
6485         assert_eq!(events.len(), 1);
6486
6487         let raa_msg = match &events[0] {
6488                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6489                         msg.clone()
6490                 },
6491                 _ => panic!("Unexpected event"),
6492         };
6493
6494         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6495         check_added_monitors!(nodes[2], 1);
6496         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6497
6498         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6499         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6500         assert_eq!(process_htlc_forwards_event.len(), 1);
6501         match &process_htlc_forwards_event[0] {
6502                 &Event::PendingHTLCsForwardable { .. } => {},
6503                 _ => panic!("Unexpected event"),
6504         }
6505
6506         // In response, we call ChannelManager's process_pending_htlc_forwards
6507         nodes[1].node.process_pending_htlc_forwards();
6508         check_added_monitors!(nodes[1], 1);
6509
6510         // This causes the HTLC to be failed backwards.
6511         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6512         assert_eq!(fail_event.len(), 1);
6513         let (fail_msg, commitment_signed) = match &fail_event[0] {
6514                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6515                         assert_eq!(updates.update_add_htlcs.len(), 0);
6516                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6517                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6518                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6519                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6520                 },
6521                 _ => panic!("Unexpected event"),
6522         };
6523
6524         // Pass the failure messages back to nodes[0].
6525         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6526         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6527
6528         // Complete the HTLC failure+removal process.
6529         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6530         check_added_monitors!(nodes[0], 1);
6531         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6532         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6533         check_added_monitors!(nodes[1], 2);
6534         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6535         assert_eq!(final_raa_event.len(), 1);
6536         let raa = match &final_raa_event[0] {
6537                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6538                 _ => panic!("Unexpected event"),
6539         };
6540         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6541         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_1_2.0.contents.short_channel_id, false);
6542         check_added_monitors!(nodes[0], 1);
6543 }
6544
6545 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6546 // 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.
6547 //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.
6548
6549 #[test]
6550 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6551         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6552         let chanmon_cfgs = create_chanmon_cfgs(2);
6553         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6554         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6555         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6556         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6557
6558         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6559         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6560         let logger = test_utils::TestLogger::new();
6561         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6562         route.paths[0][0].fee_msat = 100;
6563
6564         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6565                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6566         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6567         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6568 }
6569
6570 #[test]
6571 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6572         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6573         let chanmon_cfgs = create_chanmon_cfgs(2);
6574         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6575         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6576         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6577         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6578         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6579
6580         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6581         let logger = test_utils::TestLogger::new();
6582         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6583         route.paths[0][0].fee_msat = 0;
6584         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6585                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6586
6587         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6588         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6589 }
6590
6591 #[test]
6592 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6593         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6594         let chanmon_cfgs = create_chanmon_cfgs(2);
6595         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6596         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6597         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6598         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6599
6600         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6601         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6602         let logger = test_utils::TestLogger::new();
6603         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6604         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6605         check_added_monitors!(nodes[0], 1);
6606         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6607         updates.update_add_htlcs[0].amount_msat = 0;
6608
6609         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6610         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6611         check_closed_broadcast!(nodes[1], true).unwrap();
6612         check_added_monitors!(nodes[1], 1);
6613         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote side tried to send a 0-msat HTLC".to_string() });
6614 }
6615
6616 #[test]
6617 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6618         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6619         //It is enforced when constructing a route.
6620         let chanmon_cfgs = create_chanmon_cfgs(2);
6621         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6622         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6623         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6624         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6625         let logger = test_utils::TestLogger::new();
6626
6627         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6628
6629         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6630         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000000, 500000001, &logger).unwrap();
6631         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6632                 assert_eq!(err, &"Channel CLTV overflowed?"));
6633 }
6634
6635 #[test]
6636 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6637         //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.
6638         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6639         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6640         let chanmon_cfgs = create_chanmon_cfgs(2);
6641         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6642         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6643         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6644         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6645         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6646
6647         let logger = test_utils::TestLogger::new();
6648         for i in 0..max_accepted_htlcs {
6649                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6650                 let payment_event = {
6651                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6652                         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6653                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6654                         check_added_monitors!(nodes[0], 1);
6655
6656                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6657                         assert_eq!(events.len(), 1);
6658                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6659                                 assert_eq!(htlcs[0].htlc_id, i);
6660                         } else {
6661                                 assert!(false);
6662                         }
6663                         SendEvent::from_event(events.remove(0))
6664                 };
6665                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6666                 check_added_monitors!(nodes[1], 0);
6667                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6668
6669                 expect_pending_htlcs_forwardable!(nodes[1]);
6670                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6671         }
6672         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6673         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6674         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6675         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6676                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6677
6678         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6679         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6680 }
6681
6682 #[test]
6683 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6684         //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.
6685         let chanmon_cfgs = create_chanmon_cfgs(2);
6686         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6687         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6688         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6689         let channel_value = 100000;
6690         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6691         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6692
6693         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6694
6695         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6696         // Manually create a route over our max in flight (which our router normally automatically
6697         // limits us to.
6698         let route = Route { paths: vec![vec![RouteHop {
6699            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6700            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6701            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6702         }]] };
6703         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6704                 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)));
6705
6706         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6707         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);
6708
6709         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6710 }
6711
6712 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6713 #[test]
6714 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6715         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6716         let chanmon_cfgs = create_chanmon_cfgs(2);
6717         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6718         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6719         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6720         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6721         let htlc_minimum_msat: u64;
6722         {
6723                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6724                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6725                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6726         }
6727
6728         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6729         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6730         let logger = test_utils::TestLogger::new();
6731         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6732         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6733         check_added_monitors!(nodes[0], 1);
6734         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6735         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6736         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6737         assert!(nodes[1].node.list_channels().is_empty());
6738         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6739         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()));
6740         check_added_monitors!(nodes[1], 1);
6741         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6742 }
6743
6744 #[test]
6745 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6746         //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
6747         let chanmon_cfgs = create_chanmon_cfgs(2);
6748         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6749         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6750         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6751         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6752         let logger = test_utils::TestLogger::new();
6753
6754         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6755         let channel_reserve = chan_stat.channel_reserve_msat;
6756         let feerate = get_feerate!(nodes[0], chan.2);
6757         // The 2* and +1 are for the fee spike reserve.
6758         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6759
6760         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6761         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6762         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6763         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6764         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6765         check_added_monitors!(nodes[0], 1);
6766         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6767
6768         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6769         // at this time channel-initiatee receivers are not required to enforce that senders
6770         // respect the fee_spike_reserve.
6771         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6772         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6773
6774         assert!(nodes[1].node.list_channels().is_empty());
6775         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6776         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6777         check_added_monitors!(nodes[1], 1);
6778         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6779 }
6780
6781 #[test]
6782 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6783         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6784         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6785         let chanmon_cfgs = create_chanmon_cfgs(2);
6786         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6787         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6788         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6789         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6790         let logger = test_utils::TestLogger::new();
6791
6792         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6793         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6794
6795         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6796         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6797
6798         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6799         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6800         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6801         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6802
6803         let mut msg = msgs::UpdateAddHTLC {
6804                 channel_id: chan.2,
6805                 htlc_id: 0,
6806                 amount_msat: 1000,
6807                 payment_hash: our_payment_hash,
6808                 cltv_expiry: htlc_cltv,
6809                 onion_routing_packet: onion_packet.clone(),
6810         };
6811
6812         for i in 0..super::channel::OUR_MAX_HTLCS {
6813                 msg.htlc_id = i as u64;
6814                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6815         }
6816         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6817         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6818
6819         assert!(nodes[1].node.list_channels().is_empty());
6820         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6821         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6822         check_added_monitors!(nodes[1], 1);
6823         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6824 }
6825
6826 #[test]
6827 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6828         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6829         let chanmon_cfgs = create_chanmon_cfgs(2);
6830         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6831         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6832         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6833         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6834         let logger = test_utils::TestLogger::new();
6835
6836         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6837         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6838         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6839         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6840         check_added_monitors!(nodes[0], 1);
6841         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6842         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6843         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6844
6845         assert!(nodes[1].node.list_channels().is_empty());
6846         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6847         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6848         check_added_monitors!(nodes[1], 1);
6849         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6850 }
6851
6852 #[test]
6853 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6854         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6855         let chanmon_cfgs = create_chanmon_cfgs(2);
6856         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6857         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6858         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6859         let logger = test_utils::TestLogger::new();
6860
6861         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6862         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6863         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6864         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6865         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6866         check_added_monitors!(nodes[0], 1);
6867         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6868         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6869         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6870
6871         assert!(nodes[1].node.list_channels().is_empty());
6872         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6873         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6874         check_added_monitors!(nodes[1], 1);
6875         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6876 }
6877
6878 #[test]
6879 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6880         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6881         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6882         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6883         let chanmon_cfgs = create_chanmon_cfgs(2);
6884         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6885         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6886         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6887         let logger = test_utils::TestLogger::new();
6888
6889         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6890         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6891         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6892         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6893         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6894         check_added_monitors!(nodes[0], 1);
6895         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6896         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6897
6898         //Disconnect and Reconnect
6899         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6900         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6901         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6902         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6903         assert_eq!(reestablish_1.len(), 1);
6904         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6905         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6906         assert_eq!(reestablish_2.len(), 1);
6907         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6908         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6909         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6910         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6911
6912         //Resend HTLC
6913         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6914         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6915         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6916         check_added_monitors!(nodes[1], 1);
6917         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6918
6919         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6920
6921         assert!(nodes[1].node.list_channels().is_empty());
6922         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6923         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6924         check_added_monitors!(nodes[1], 1);
6925         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6926 }
6927
6928 #[test]
6929 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6930         //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.
6931
6932         let chanmon_cfgs = create_chanmon_cfgs(2);
6933         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6934         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6935         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6936         let logger = test_utils::TestLogger::new();
6937         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6938         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6939         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6940         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6941         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6942
6943         check_added_monitors!(nodes[0], 1);
6944         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6945         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6946
6947         let update_msg = msgs::UpdateFulfillHTLC{
6948                 channel_id: chan.2,
6949                 htlc_id: 0,
6950                 payment_preimage: our_payment_preimage,
6951         };
6952
6953         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6954
6955         assert!(nodes[0].node.list_channels().is_empty());
6956         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6957         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()));
6958         check_added_monitors!(nodes[0], 1);
6959         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6960 }
6961
6962 #[test]
6963 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6964         //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.
6965
6966         let chanmon_cfgs = create_chanmon_cfgs(2);
6967         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6968         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6969         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6970         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6971         let logger = test_utils::TestLogger::new();
6972
6973         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6974         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6975         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6976         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6977         check_added_monitors!(nodes[0], 1);
6978         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6979         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6980
6981         let update_msg = msgs::UpdateFailHTLC{
6982                 channel_id: chan.2,
6983                 htlc_id: 0,
6984                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6985         };
6986
6987         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6988
6989         assert!(nodes[0].node.list_channels().is_empty());
6990         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6991         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()));
6992         check_added_monitors!(nodes[0], 1);
6993         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6994 }
6995
6996 #[test]
6997 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6998         //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.
6999
7000         let chanmon_cfgs = create_chanmon_cfgs(2);
7001         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7002         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7003         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7004         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7005         let logger = test_utils::TestLogger::new();
7006
7007         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7008         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7009         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7010         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7011         check_added_monitors!(nodes[0], 1);
7012         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7013         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7014         let update_msg = msgs::UpdateFailMalformedHTLC{
7015                 channel_id: chan.2,
7016                 htlc_id: 0,
7017                 sha256_of_onion: [1; 32],
7018                 failure_code: 0x8000,
7019         };
7020
7021         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7022
7023         assert!(nodes[0].node.list_channels().is_empty());
7024         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7025         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()));
7026         check_added_monitors!(nodes[0], 1);
7027         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
7028 }
7029
7030 #[test]
7031 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
7032         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
7033
7034         let chanmon_cfgs = create_chanmon_cfgs(2);
7035         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7036         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7037         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7038         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7039
7040         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7041
7042         nodes[1].node.claim_funds(our_payment_preimage);
7043         check_added_monitors!(nodes[1], 1);
7044
7045         let events = nodes[1].node.get_and_clear_pending_msg_events();
7046         assert_eq!(events.len(), 1);
7047         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7048                 match events[0] {
7049                         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, .. } } => {
7050                                 assert!(update_add_htlcs.is_empty());
7051                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7052                                 assert!(update_fail_htlcs.is_empty());
7053                                 assert!(update_fail_malformed_htlcs.is_empty());
7054                                 assert!(update_fee.is_none());
7055                                 update_fulfill_htlcs[0].clone()
7056                         },
7057                         _ => panic!("Unexpected event"),
7058                 }
7059         };
7060
7061         update_fulfill_msg.htlc_id = 1;
7062
7063         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7064
7065         assert!(nodes[0].node.list_channels().is_empty());
7066         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7067         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7068         check_added_monitors!(nodes[0], 1);
7069         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
7070 }
7071
7072 #[test]
7073 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7074         //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.
7075
7076         let chanmon_cfgs = create_chanmon_cfgs(2);
7077         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7078         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7079         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7080         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7081
7082         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7083
7084         nodes[1].node.claim_funds(our_payment_preimage);
7085         check_added_monitors!(nodes[1], 1);
7086
7087         let events = nodes[1].node.get_and_clear_pending_msg_events();
7088         assert_eq!(events.len(), 1);
7089         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7090                 match events[0] {
7091                         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, .. } } => {
7092                                 assert!(update_add_htlcs.is_empty());
7093                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7094                                 assert!(update_fail_htlcs.is_empty());
7095                                 assert!(update_fail_malformed_htlcs.is_empty());
7096                                 assert!(update_fee.is_none());
7097                                 update_fulfill_htlcs[0].clone()
7098                         },
7099                         _ => panic!("Unexpected event"),
7100                 }
7101         };
7102
7103         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7104
7105         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7106
7107         assert!(nodes[0].node.list_channels().is_empty());
7108         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7109         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7110         check_added_monitors!(nodes[0], 1);
7111         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
7112 }
7113
7114 #[test]
7115 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7116         //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.
7117
7118         let chanmon_cfgs = create_chanmon_cfgs(2);
7119         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7120         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7121         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7122         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7123         let logger = test_utils::TestLogger::new();
7124
7125         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
7126         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7127         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7128         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7129         check_added_monitors!(nodes[0], 1);
7130
7131         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7132         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7133
7134         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7135         check_added_monitors!(nodes[1], 0);
7136         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7137
7138         let events = nodes[1].node.get_and_clear_pending_msg_events();
7139
7140         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7141                 match events[0] {
7142                         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, .. } } => {
7143                                 assert!(update_add_htlcs.is_empty());
7144                                 assert!(update_fulfill_htlcs.is_empty());
7145                                 assert!(update_fail_htlcs.is_empty());
7146                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7147                                 assert!(update_fee.is_none());
7148                                 update_fail_malformed_htlcs[0].clone()
7149                         },
7150                         _ => panic!("Unexpected event"),
7151                 }
7152         };
7153         update_msg.failure_code &= !0x8000;
7154         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7155
7156         assert!(nodes[0].node.list_channels().is_empty());
7157         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7158         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7159         check_added_monitors!(nodes[0], 1);
7160         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
7161 }
7162
7163 #[test]
7164 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7165         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7166         //    * 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.
7167
7168         let chanmon_cfgs = create_chanmon_cfgs(3);
7169         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7170         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7171         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7172         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7173         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7174         let logger = test_utils::TestLogger::new();
7175
7176         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7177
7178         //First hop
7179         let mut payment_event = {
7180                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7181                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
7182                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7183                 check_added_monitors!(nodes[0], 1);
7184                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7185                 assert_eq!(events.len(), 1);
7186                 SendEvent::from_event(events.remove(0))
7187         };
7188         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7189         check_added_monitors!(nodes[1], 0);
7190         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7191         expect_pending_htlcs_forwardable!(nodes[1]);
7192         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7193         assert_eq!(events_2.len(), 1);
7194         check_added_monitors!(nodes[1], 1);
7195         payment_event = SendEvent::from_event(events_2.remove(0));
7196         assert_eq!(payment_event.msgs.len(), 1);
7197
7198         //Second Hop
7199         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7200         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7201         check_added_monitors!(nodes[2], 0);
7202         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7203
7204         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7205         assert_eq!(events_3.len(), 1);
7206         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7207                 match events_3[0] {
7208                         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 } } => {
7209                                 assert!(update_add_htlcs.is_empty());
7210                                 assert!(update_fulfill_htlcs.is_empty());
7211                                 assert!(update_fail_htlcs.is_empty());
7212                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7213                                 assert!(update_fee.is_none());
7214                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7215                         },
7216                         _ => panic!("Unexpected event"),
7217                 }
7218         };
7219
7220         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7221
7222         check_added_monitors!(nodes[1], 0);
7223         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7224         expect_pending_htlcs_forwardable!(nodes[1]);
7225         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7226         assert_eq!(events_4.len(), 1);
7227
7228         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7229         match events_4[0] {
7230                 MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, .. } } => {
7231                         assert!(update_add_htlcs.is_empty());
7232                         assert!(update_fulfill_htlcs.is_empty());
7233                         assert_eq!(update_fail_htlcs.len(), 1);
7234                         assert!(update_fail_malformed_htlcs.is_empty());
7235                         assert!(update_fee.is_none());
7236                 },
7237                 _ => panic!("Unexpected event"),
7238         };
7239
7240         check_added_monitors!(nodes[1], 1);
7241 }
7242
7243 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7244         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7245         // 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
7246         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7247
7248         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7249         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7250         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7251         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7252         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7253         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7254
7255         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7256
7257         // We route 2 dust-HTLCs between A and B
7258         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7259         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7260         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7261
7262         // Cache one local commitment tx as previous
7263         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7264
7265         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7266         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7267         check_added_monitors!(nodes[1], 0);
7268         expect_pending_htlcs_forwardable!(nodes[1]);
7269         check_added_monitors!(nodes[1], 1);
7270
7271         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7272         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7273         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7274         check_added_monitors!(nodes[0], 1);
7275
7276         // Cache one local commitment tx as lastest
7277         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7278
7279         let events = nodes[0].node.get_and_clear_pending_msg_events();
7280         match events[0] {
7281                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7282                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7283                 },
7284                 _ => panic!("Unexpected event"),
7285         }
7286         match events[1] {
7287                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7288                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7289                 },
7290                 _ => panic!("Unexpected event"),
7291         }
7292
7293         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7294         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7295         if announce_latest {
7296                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7297         } else {
7298                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7299         }
7300
7301         check_closed_broadcast!(nodes[0], true);
7302         check_added_monitors!(nodes[0], 1);
7303         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
7304
7305         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7306         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7307         let events = nodes[0].node.get_and_clear_pending_events();
7308         // Only 2 PaymentPathFailed events should show up, over-dust HTLC has to be failed by timeout tx
7309         assert_eq!(events.len(), 2);
7310         let mut first_failed = false;
7311         for event in events {
7312                 match event {
7313                         Event::PaymentPathFailed { payment_hash, .. } => {
7314                                 if payment_hash == payment_hash_1 {
7315                                         assert!(!first_failed);
7316                                         first_failed = true;
7317                                 } else {
7318                                         assert_eq!(payment_hash, payment_hash_2);
7319                                 }
7320                         }
7321                         _ => panic!("Unexpected event"),
7322                 }
7323         }
7324 }
7325
7326 #[test]
7327 fn test_failure_delay_dust_htlc_local_commitment() {
7328         do_test_failure_delay_dust_htlc_local_commitment(true);
7329         do_test_failure_delay_dust_htlc_local_commitment(false);
7330 }
7331
7332 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7333         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7334         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7335         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7336         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7337         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7338         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7339
7340         let chanmon_cfgs = create_chanmon_cfgs(3);
7341         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7342         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7343         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7344         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7345
7346         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7347
7348         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7349         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7350
7351         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7352         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7353
7354         // We revoked bs_commitment_tx
7355         if revoked {
7356                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7357                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7358         }
7359
7360         let mut timeout_tx = Vec::new();
7361         if local {
7362                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7363                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7364                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
7365                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7366                 expect_payment_failed!(nodes[0], dust_hash, true);
7367
7368                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7369                 check_closed_broadcast!(nodes[0], true);
7370                 check_added_monitors!(nodes[0], 1);
7371                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7372                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7373                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7374                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7375                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7376                 mine_transaction(&nodes[0], &timeout_tx[0]);
7377                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7378                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7379         } else {
7380                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7381                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7382                 check_closed_broadcast!(nodes[0], true);
7383                 check_added_monitors!(nodes[0], 1);
7384                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
7385                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7386                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7387                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7388                 if !revoked {
7389                         expect_payment_failed!(nodes[0], dust_hash, true);
7390                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7391                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7392                         mine_transaction(&nodes[0], &timeout_tx[0]);
7393                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7394                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7395                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7396                 } else {
7397                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7398                         // commitment tx
7399                         let events = nodes[0].node.get_and_clear_pending_events();
7400                         assert_eq!(events.len(), 2);
7401                         let first;
7402                         match events[0] {
7403                                 Event::PaymentPathFailed { payment_hash, .. } => {
7404                                         if payment_hash == dust_hash { first = true; }
7405                                         else { first = false; }
7406                                 },
7407                                 _ => panic!("Unexpected event"),
7408                         }
7409                         match events[1] {
7410                                 Event::PaymentPathFailed { payment_hash, .. } => {
7411                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7412                                         else { assert_eq!(payment_hash, dust_hash); }
7413                                 },
7414                                 _ => panic!("Unexpected event"),
7415                         }
7416                 }
7417         }
7418 }
7419
7420 #[test]
7421 fn test_sweep_outbound_htlc_failure_update() {
7422         do_test_sweep_outbound_htlc_failure_update(false, true);
7423         do_test_sweep_outbound_htlc_failure_update(false, false);
7424         do_test_sweep_outbound_htlc_failure_update(true, false);
7425 }
7426
7427 #[test]
7428 fn test_user_configurable_csv_delay() {
7429         // We test our channel constructors yield errors when we pass them absurd csv delay
7430
7431         let mut low_our_to_self_config = UserConfig::default();
7432         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7433         let mut high_their_to_self_config = UserConfig::default();
7434         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7435         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7436         let chanmon_cfgs = create_chanmon_cfgs(2);
7437         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7438         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7439         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7440
7441         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7442         if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &InitFeatures::known(), 1000000, 1000000, 0, &low_our_to_self_config) {
7443                 match error {
7444                         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())); },
7445                         _ => panic!("Unexpected event"),
7446                 }
7447         } else { assert!(false) }
7448
7449         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7450         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7451         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7452         open_channel.to_self_delay = 200;
7453         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7454                 match error {
7455                         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()));  },
7456                         _ => panic!("Unexpected event"),
7457                 }
7458         } else { assert!(false); }
7459
7460         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7461         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7462         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()));
7463         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7464         accept_channel.to_self_delay = 200;
7465         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7466         let reason_msg;
7467         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7468                 match action {
7469                         &ErrorAction::SendErrorMessage { ref msg } => {
7470                                 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()));
7471                                 reason_msg = msg.data.clone();
7472                         },
7473                         _ => { panic!(); }
7474                 }
7475         } else { panic!(); }
7476         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: reason_msg });
7477
7478         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7479         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7480         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7481         open_channel.to_self_delay = 200;
7482         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7483                 match error {
7484                         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())); },
7485                         _ => panic!("Unexpected event"),
7486                 }
7487         } else { assert!(false); }
7488 }
7489
7490 #[test]
7491 fn test_data_loss_protect() {
7492         // We want to be sure that :
7493         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7494         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7495         // * we close channel in case of detecting other being fallen behind
7496         // * we are able to claim our own outputs thanks to to_remote being static
7497         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7498         let persister;
7499         let logger;
7500         let fee_estimator;
7501         let tx_broadcaster;
7502         let chain_source;
7503         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7504         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7505         // during signing due to revoked tx
7506         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7507         let keys_manager = &chanmon_cfgs[0].keys_manager;
7508         let monitor;
7509         let node_state_0;
7510         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7511         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7512         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7513
7514         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7515
7516         // Cache node A state before any channel update
7517         let previous_node_state = nodes[0].node.encode();
7518         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7519         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7520
7521         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7522         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7523
7524         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7525         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7526
7527         // Restore node A from previous state
7528         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7529         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7530         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7531         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7532         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7533         persister = test_utils::TestPersister::new();
7534         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7535         node_state_0 = {
7536                 let mut channel_monitors = HashMap::new();
7537                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7538                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7539                         keys_manager: keys_manager,
7540                         fee_estimator: &fee_estimator,
7541                         chain_monitor: &monitor,
7542                         logger: &logger,
7543                         tx_broadcaster: &tx_broadcaster,
7544                         default_config: UserConfig::default(),
7545                         channel_monitors,
7546                 }).unwrap().1
7547         };
7548         nodes[0].node = &node_state_0;
7549         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7550         nodes[0].chain_monitor = &monitor;
7551         nodes[0].chain_source = &chain_source;
7552
7553         check_added_monitors!(nodes[0], 1);
7554
7555         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7556         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7557
7558         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7559
7560         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7561         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7562         check_added_monitors!(nodes[0], 1);
7563
7564         {
7565                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7566                 assert_eq!(node_txn.len(), 0);
7567         }
7568
7569         let mut reestablish_1 = Vec::with_capacity(1);
7570         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7571                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7572                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7573                         reestablish_1.push(msg.clone());
7574                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7575                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7576                         match action {
7577                                 &ErrorAction::SendErrorMessage { ref msg } => {
7578                                         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");
7579                                 },
7580                                 _ => panic!("Unexpected event!"),
7581                         }
7582                 } else {
7583                         panic!("Unexpected event")
7584                 }
7585         }
7586
7587         // Check we close channel detecting A is fallen-behind
7588         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7589         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Peer attempted to reestablish channel with a very old local commitment transaction".to_string() });
7590         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7591         check_added_monitors!(nodes[1], 1);
7592
7593         // Check A is able to claim to_remote output
7594         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7595         assert_eq!(node_txn.len(), 1);
7596         check_spends!(node_txn[0], chan.3);
7597         assert_eq!(node_txn[0].output.len(), 2);
7598         mine_transaction(&nodes[0], &node_txn[0]);
7599         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7600         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "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".to_string() });
7601         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7602         assert_eq!(spend_txn.len(), 1);
7603         check_spends!(spend_txn[0], node_txn[0]);
7604 }
7605
7606 #[test]
7607 fn test_check_htlc_underpaying() {
7608         // Send payment through A -> B but A is maliciously
7609         // sending a probe payment (i.e less than expected value0
7610         // to B, B should refuse payment.
7611
7612         let chanmon_cfgs = create_chanmon_cfgs(2);
7613         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7614         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7615         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7616
7617         // Create some initial channels
7618         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7619
7620         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7621         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7622         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7623         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7624         check_added_monitors!(nodes[0], 1);
7625
7626         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7627         assert_eq!(events.len(), 1);
7628         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7629         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7630         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7631
7632         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7633         // and then will wait a second random delay before failing the HTLC back:
7634         expect_pending_htlcs_forwardable!(nodes[1]);
7635         expect_pending_htlcs_forwardable!(nodes[1]);
7636
7637         // Node 3 is expecting payment of 100_000 but received 10_000,
7638         // it should fail htlc like we didn't know the preimage.
7639         nodes[1].node.process_pending_htlc_forwards();
7640
7641         let events = nodes[1].node.get_and_clear_pending_msg_events();
7642         assert_eq!(events.len(), 1);
7643         let (update_fail_htlc, commitment_signed) = match events[0] {
7644                 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 } } => {
7645                         assert!(update_add_htlcs.is_empty());
7646                         assert!(update_fulfill_htlcs.is_empty());
7647                         assert_eq!(update_fail_htlcs.len(), 1);
7648                         assert!(update_fail_malformed_htlcs.is_empty());
7649                         assert!(update_fee.is_none());
7650                         (update_fail_htlcs[0].clone(), commitment_signed)
7651                 },
7652                 _ => panic!("Unexpected event"),
7653         };
7654         check_added_monitors!(nodes[1], 1);
7655
7656         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7657         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7658
7659         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7660         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7661         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7662         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7663 }
7664
7665 #[test]
7666 fn test_announce_disable_channels() {
7667         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7668         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7669
7670         let chanmon_cfgs = create_chanmon_cfgs(2);
7671         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7672         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7673         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7674
7675         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7676         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7677         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7678
7679         // Disconnect peers
7680         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7681         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7682
7683         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7684         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7685         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7686         assert_eq!(msg_events.len(), 3);
7687         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7688         for e in msg_events {
7689                 match e {
7690                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7691                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7692                                 // Check that each channel gets updated exactly once
7693                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7694                                         panic!("Generated ChannelUpdate for wrong chan!");
7695                                 }
7696                         },
7697                         _ => panic!("Unexpected event"),
7698                 }
7699         }
7700         // Reconnect peers
7701         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7702         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7703         assert_eq!(reestablish_1.len(), 3);
7704         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7705         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7706         assert_eq!(reestablish_2.len(), 3);
7707
7708         // Reestablish chan_1
7709         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7710         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7711         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7712         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7713         // Reestablish chan_2
7714         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7715         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7716         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7717         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7718         // Reestablish chan_3
7719         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7720         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7721         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7722         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7723
7724         nodes[0].node.timer_tick_occurred();
7725         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7726         nodes[0].node.timer_tick_occurred();
7727         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7728         assert_eq!(msg_events.len(), 3);
7729         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7730         for e in msg_events {
7731                 match e {
7732                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7733                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7734                                 // Check that each channel gets updated exactly once
7735                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7736                                         panic!("Generated ChannelUpdate for wrong chan!");
7737                                 }
7738                         },
7739                         _ => panic!("Unexpected event"),
7740                 }
7741         }
7742 }
7743
7744 #[test]
7745 fn test_priv_forwarding_rejection() {
7746         // If we have a private channel with outbound liquidity, and
7747         // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
7748         // to forward through that channel.
7749         let chanmon_cfgs = create_chanmon_cfgs(3);
7750         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7751         let mut no_announce_cfg = test_default_channel_config();
7752         no_announce_cfg.channel_options.announced_channel = false;
7753         no_announce_cfg.accept_forwards_to_priv_channels = false;
7754         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
7755         let persister: test_utils::TestPersister;
7756         let new_chain_monitor: test_utils::TestChainMonitor;
7757         let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
7758         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7759
7760         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
7761
7762         // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
7763         // not send for private channels.
7764         nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7765         let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
7766         nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7767         let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
7768         nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7769
7770         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
7771         nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
7772         nodes[2].node.handle_funding_created(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingCreated, nodes[2].node.get_our_node_id()));
7773         check_added_monitors!(nodes[2], 1);
7774
7775         nodes[1].node.handle_funding_signed(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendFundingSigned, nodes[1].node.get_our_node_id()));
7776         check_added_monitors!(nodes[1], 1);
7777
7778         let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
7779         confirm_transaction_at(&nodes[1], &tx, conf_height);
7780         connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
7781         confirm_transaction_at(&nodes[2], &tx, conf_height);
7782         connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
7783         let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
7784         nodes[1].node.handle_funding_locked(&nodes[2].node.get_our_node_id(), &get_event_msg!(nodes[2], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id()));
7785         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7786         nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
7787         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7788
7789         assert!(nodes[0].node.list_usable_channels()[0].is_public);
7790         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
7791         assert!(!nodes[2].node.list_usable_channels()[0].is_public);
7792
7793         // We should always be able to forward through nodes[1] as long as its out through a public
7794         // channel:
7795         send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
7796
7797         // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
7798         // to nodes[2], which should be rejected:
7799         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7800         let route = get_route(&nodes[0].node.get_our_node_id(),
7801                 &nodes[0].net_graph_msg_handler.network_graph,
7802                 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
7803                 &[&RouteHint(vec![RouteHintHop {
7804                         src_node_id: nodes[1].node.get_our_node_id(),
7805                         short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
7806                         fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
7807                         cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
7808                         htlc_minimum_msat: None,
7809                         htlc_maximum_msat: None,
7810                 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7811
7812         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7813         check_added_monitors!(nodes[0], 1);
7814         let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7815         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7816         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
7817
7818         let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7819         assert!(htlc_fail_updates.update_add_htlcs.is_empty());
7820         assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
7821         assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
7822         assert!(htlc_fail_updates.update_fee.is_none());
7823
7824         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
7825         commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
7826         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
7827
7828         // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
7829         // to true. Sadly there is currently no way to change it at runtime.
7830
7831         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7832         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7833
7834         let nodes_1_serialized = nodes[1].node.encode();
7835         let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
7836         let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
7837         {
7838                 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
7839                 let mut mon_iter = mons.iter();
7840                 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
7841                 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
7842         }
7843
7844         persister = test_utils::TestPersister::new();
7845         let keys_manager = &chanmon_cfgs[1].keys_manager;
7846         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger, node_cfgs[1].fee_estimator, &persister, keys_manager);
7847         nodes[1].chain_monitor = &new_chain_monitor;
7848
7849         let mut monitor_a_read = &monitor_a_serialized.0[..];
7850         let mut monitor_b_read = &monitor_b_serialized.0[..];
7851         let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
7852         let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
7853         assert!(monitor_a_read.is_empty());
7854         assert!(monitor_b_read.is_empty());
7855
7856         no_announce_cfg.accept_forwards_to_priv_channels = true;
7857
7858         let mut nodes_1_read = &nodes_1_serialized[..];
7859         let (_, nodes_1_deserialized_tmp) = {
7860                 let mut channel_monitors = HashMap::new();
7861                 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
7862                 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
7863                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
7864                         default_config: no_announce_cfg,
7865                         keys_manager,
7866                         fee_estimator: node_cfgs[1].fee_estimator,
7867                         chain_monitor: nodes[1].chain_monitor,
7868                         tx_broadcaster: nodes[1].tx_broadcaster.clone(),
7869                         logger: nodes[1].logger,
7870                         channel_monitors,
7871                 }).unwrap()
7872         };
7873         assert!(nodes_1_read.is_empty());
7874         nodes_1_deserialized = nodes_1_deserialized_tmp;
7875
7876         assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
7877         assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
7878         check_added_monitors!(nodes[1], 2);
7879         nodes[1].node = &nodes_1_deserialized;
7880
7881         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7882         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7883         let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7884         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
7885         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
7886         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7887         get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7888         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
7889
7890         nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7891         nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7892         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
7893         let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7894         nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7895         nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
7896         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7897         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7898
7899         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7900         check_added_monitors!(nodes[0], 1);
7901         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
7902         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
7903 }
7904
7905 #[test]
7906 fn test_bump_penalty_txn_on_revoked_commitment() {
7907         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7908         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7909
7910         let chanmon_cfgs = create_chanmon_cfgs(2);
7911         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7912         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7913         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7914
7915         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7916         let logger = test_utils::TestLogger::new();
7917
7918         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7919         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7920         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7921         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7922
7923         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7924         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7925         assert_eq!(revoked_txn[0].output.len(), 4);
7926         assert_eq!(revoked_txn[0].input.len(), 1);
7927         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7928         let revoked_txid = revoked_txn[0].txid();
7929
7930         let mut penalty_sum = 0;
7931         for outp in revoked_txn[0].output.iter() {
7932                 if outp.script_pubkey.is_v0_p2wsh() {
7933                         penalty_sum += outp.value;
7934                 }
7935         }
7936
7937         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7938         let header_114 = connect_blocks(&nodes[1], 14);
7939
7940         // Actually revoke tx by claiming a HTLC
7941         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7942         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7943         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7944         check_added_monitors!(nodes[1], 1);
7945
7946         // One or more justice tx should have been broadcast, check it
7947         let penalty_1;
7948         let feerate_1;
7949         {
7950                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7951                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7952                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7953                 assert_eq!(node_txn[0].output.len(), 1);
7954                 check_spends!(node_txn[0], revoked_txn[0]);
7955                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7956                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7957                 penalty_1 = node_txn[0].txid();
7958                 node_txn.clear();
7959         };
7960
7961         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7962         connect_blocks(&nodes[1], 15);
7963         let mut penalty_2 = penalty_1;
7964         let mut feerate_2 = 0;
7965         {
7966                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7967                 assert_eq!(node_txn.len(), 1);
7968                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7969                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7970                         assert_eq!(node_txn[0].output.len(), 1);
7971                         check_spends!(node_txn[0], revoked_txn[0]);
7972                         penalty_2 = node_txn[0].txid();
7973                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7974                         assert_ne!(penalty_2, penalty_1);
7975                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7976                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7977                         // Verify 25% bump heuristic
7978                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7979                         node_txn.clear();
7980                 }
7981         }
7982         assert_ne!(feerate_2, 0);
7983
7984         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7985         connect_blocks(&nodes[1], 1);
7986         let penalty_3;
7987         let mut feerate_3 = 0;
7988         {
7989                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7990                 assert_eq!(node_txn.len(), 1);
7991                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7992                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7993                         assert_eq!(node_txn[0].output.len(), 1);
7994                         check_spends!(node_txn[0], revoked_txn[0]);
7995                         penalty_3 = node_txn[0].txid();
7996                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7997                         assert_ne!(penalty_3, penalty_2);
7998                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7999                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8000                         // Verify 25% bump heuristic
8001                         assert!(feerate_3 * 100 >= feerate_2 * 125);
8002                         node_txn.clear();
8003                 }
8004         }
8005         assert_ne!(feerate_3, 0);
8006
8007         nodes[1].node.get_and_clear_pending_events();
8008         nodes[1].node.get_and_clear_pending_msg_events();
8009 }
8010
8011 #[test]
8012 fn test_bump_penalty_txn_on_revoked_htlcs() {
8013         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8014         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8015
8016         let mut chanmon_cfgs = create_chanmon_cfgs(2);
8017         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
8018         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8019         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8020         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8021
8022         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8023         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
8024         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
8025                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8026         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
8027         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
8028                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
8029         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
8030
8031         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8032         assert_eq!(revoked_local_txn[0].input.len(), 1);
8033         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8034
8035         // Revoke local commitment tx
8036         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8037
8038         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8039         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8040         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
8041         check_closed_broadcast!(nodes[1], true);
8042         check_added_monitors!(nodes[1], 1);
8043         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
8044         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
8045
8046         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8047         assert_eq!(revoked_htlc_txn.len(), 3);
8048         check_spends!(revoked_htlc_txn[1], chan.3);
8049
8050         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
8051         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8052         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8053
8054         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
8055         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8056         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
8057         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
8058
8059         // Broadcast set of revoked txn on A
8060         let hash_128 = connect_blocks(&nodes[0], 40);
8061         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8062         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
8063         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8064         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
8065         let events = nodes[0].node.get_and_clear_pending_events();
8066         expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
8067         match events[1] {
8068                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
8069                 _ => panic!("Unexpected event"),
8070         }
8071         let first;
8072         let feerate_1;
8073         let penalty_txn;
8074         {
8075                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8076                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8077                 // Verify claim tx are spending revoked HTLC txn
8078
8079                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
8080                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
8081                 // which are included in the same block (they are broadcasted because we scan the
8082                 // transactions linearly and generate claims as we go, they likely should be removed in the
8083                 // future).
8084                 assert_eq!(node_txn[0].input.len(), 1);
8085                 check_spends!(node_txn[0], revoked_local_txn[0]);
8086                 assert_eq!(node_txn[1].input.len(), 1);
8087                 check_spends!(node_txn[1], revoked_local_txn[0]);
8088                 assert_eq!(node_txn[2].input.len(), 1);
8089                 check_spends!(node_txn[2], revoked_local_txn[0]);
8090
8091                 // Each of the three justice transactions claim a separate (single) output of the three
8092                 // available, which we check here:
8093                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
8094                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
8095                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
8096
8097                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8098                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8099
8100                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
8101                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
8102                 // a remote commitment tx has already been confirmed).
8103                 check_spends!(node_txn[3], chan.3);
8104
8105                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
8106                 // output, checked above).
8107                 assert_eq!(node_txn[4].input.len(), 2);
8108                 assert_eq!(node_txn[4].output.len(), 1);
8109                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8110
8111                 first = node_txn[4].txid();
8112                 // Store both feerates for later comparison
8113                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
8114                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8115                 penalty_txn = vec![node_txn[2].clone()];
8116                 node_txn.clear();
8117         }
8118
8119         // Connect one more block to see if bumped penalty are issued for HTLC txn
8120         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8121         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8122         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8123         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
8124         {
8125                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8126                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8127
8128                 check_spends!(node_txn[0], revoked_local_txn[0]);
8129                 check_spends!(node_txn[1], revoked_local_txn[0]);
8130                 // Note that these are both bogus - they spend outputs already claimed in block 129:
8131                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
8132                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8133                 } else {
8134                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
8135                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
8136                 }
8137
8138                 node_txn.clear();
8139         };
8140
8141         // Few more blocks to confirm penalty txn
8142         connect_blocks(&nodes[0], 4);
8143         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8144         let header_144 = connect_blocks(&nodes[0], 9);
8145         let node_txn = {
8146                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8147                 assert_eq!(node_txn.len(), 1);
8148
8149                 assert_eq!(node_txn[0].input.len(), 2);
8150                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
8151                 // Verify bumped tx is different and 25% bump heuristic
8152                 assert_ne!(first, node_txn[0].txid());
8153                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
8154                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8155                 assert!(feerate_2 * 100 > feerate_1 * 125);
8156                 let txn = vec![node_txn[0].clone()];
8157                 node_txn.clear();
8158                 txn
8159         };
8160         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8161         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8162         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
8163         connect_blocks(&nodes[0], 20);
8164         {
8165                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8166                 // We verify than no new transaction has been broadcast because previously
8167                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8168                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8169                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8170                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8171                 // up bumped justice generation.
8172                 assert_eq!(node_txn.len(), 0);
8173                 node_txn.clear();
8174         }
8175         check_closed_broadcast!(nodes[0], true);
8176         check_added_monitors!(nodes[0], 1);
8177 }
8178
8179 #[test]
8180 fn test_bump_penalty_txn_on_remote_commitment() {
8181         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8182         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8183
8184         // Create 2 HTLCs
8185         // Provide preimage for one
8186         // Check aggregation
8187
8188         let chanmon_cfgs = create_chanmon_cfgs(2);
8189         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8190         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8191         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8192
8193         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8194         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8195         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8196
8197         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8198         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8199         assert_eq!(remote_txn[0].output.len(), 4);
8200         assert_eq!(remote_txn[0].input.len(), 1);
8201         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8202
8203         // Claim a HTLC without revocation (provide B monitor with preimage)
8204         nodes[1].node.claim_funds(payment_preimage);
8205         mine_transaction(&nodes[1], &remote_txn[0]);
8206         check_added_monitors!(nodes[1], 2);
8207         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8208
8209         // One or more claim tx should have been broadcast, check it
8210         let timeout;
8211         let preimage;
8212         let preimage_bump;
8213         let feerate_timeout;
8214         let feerate_preimage;
8215         {
8216                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8217                 // 9 transactions including:
8218                 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8219                 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8220                 // 2 * HTLC-Success (one RBF bump we'll check later)
8221                 // 1 * HTLC-Timeout
8222                 assert_eq!(node_txn.len(), 8);
8223                 assert_eq!(node_txn[0].input.len(), 1);
8224                 assert_eq!(node_txn[6].input.len(), 1);
8225                 check_spends!(node_txn[0], remote_txn[0]);
8226                 check_spends!(node_txn[6], remote_txn[0]);
8227                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8228                 preimage_bump = node_txn[3].clone();
8229
8230                 check_spends!(node_txn[1], chan.3);
8231                 check_spends!(node_txn[2], node_txn[1]);
8232                 assert_eq!(node_txn[1], node_txn[4]);
8233                 assert_eq!(node_txn[2], node_txn[5]);
8234
8235                 timeout = node_txn[6].txid();
8236                 let index = node_txn[6].input[0].previous_output.vout;
8237                 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8238                 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8239
8240                 preimage = node_txn[0].txid();
8241                 let index = node_txn[0].input[0].previous_output.vout;
8242                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8243                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8244
8245                 node_txn.clear();
8246         };
8247         assert_ne!(feerate_timeout, 0);
8248         assert_ne!(feerate_preimage, 0);
8249
8250         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8251         connect_blocks(&nodes[1], 15);
8252         {
8253                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8254                 assert_eq!(node_txn.len(), 1);
8255                 assert_eq!(node_txn[0].input.len(), 1);
8256                 assert_eq!(preimage_bump.input.len(), 1);
8257                 check_spends!(node_txn[0], remote_txn[0]);
8258                 check_spends!(preimage_bump, remote_txn[0]);
8259
8260                 let index = preimage_bump.input[0].previous_output.vout;
8261                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8262                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8263                 assert!(new_feerate * 100 > feerate_timeout * 125);
8264                 assert_ne!(timeout, preimage_bump.txid());
8265
8266                 let index = node_txn[0].input[0].previous_output.vout;
8267                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8268                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8269                 assert!(new_feerate * 100 > feerate_preimage * 125);
8270                 assert_ne!(preimage, node_txn[0].txid());
8271
8272                 node_txn.clear();
8273         }
8274
8275         nodes[1].node.get_and_clear_pending_events();
8276         nodes[1].node.get_and_clear_pending_msg_events();
8277 }
8278
8279 #[test]
8280 fn test_counterparty_raa_skip_no_crash() {
8281         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8282         // commitment transaction, we would have happily carried on and provided them the next
8283         // commitment transaction based on one RAA forward. This would probably eventually have led to
8284         // channel closure, but it would not have resulted in funds loss. Still, our
8285         // EnforcingSigner would have panicked as it doesn't like jumps into the future. Here, we
8286         // check simply that the channel is closed in response to such an RAA, but don't check whether
8287         // we decide to punish our counterparty for revoking their funds (as we don't currently
8288         // implement that).
8289         let chanmon_cfgs = create_chanmon_cfgs(2);
8290         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8291         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8292         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8293         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8294
8295         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8296         let keys = guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8297
8298         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8299
8300         // Make signer believe we got a counterparty signature, so that it allows the revocation
8301         keys.get_enforcement_state().last_holder_commitment -= 1;
8302         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8303
8304         // Must revoke without gaps
8305         keys.get_enforcement_state().last_holder_commitment -= 1;
8306         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8307
8308         keys.get_enforcement_state().last_holder_commitment -= 1;
8309         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8310                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8311
8312         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8313                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8314         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8315         check_added_monitors!(nodes[1], 1);
8316         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Received an unexpected revoke_and_ack".to_string() });
8317 }
8318
8319 #[test]
8320 fn test_bump_txn_sanitize_tracking_maps() {
8321         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8322         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8323
8324         let chanmon_cfgs = create_chanmon_cfgs(2);
8325         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8326         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8327         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8328
8329         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8330         // Lock HTLC in both directions
8331         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8332         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8333
8334         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8335         assert_eq!(revoked_local_txn[0].input.len(), 1);
8336         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8337
8338         // Revoke local commitment tx
8339         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8340
8341         // Broadcast set of revoked txn on A
8342         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8343         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8344         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8345
8346         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8347         check_closed_broadcast!(nodes[0], true);
8348         check_added_monitors!(nodes[0], 1);
8349         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
8350         let penalty_txn = {
8351                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8352                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8353                 check_spends!(node_txn[0], revoked_local_txn[0]);
8354                 check_spends!(node_txn[1], revoked_local_txn[0]);
8355                 check_spends!(node_txn[2], revoked_local_txn[0]);
8356                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8357                 node_txn.clear();
8358                 penalty_txn
8359         };
8360         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8361         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8362         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8363         {
8364                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8365                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8366                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8367                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8368                 }
8369         }
8370 }
8371
8372 #[test]
8373 fn test_override_channel_config() {
8374         let chanmon_cfgs = create_chanmon_cfgs(2);
8375         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8376         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8377         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8378
8379         // Node0 initiates a channel to node1 using the override config.
8380         let mut override_config = UserConfig::default();
8381         override_config.own_channel_config.our_to_self_delay = 200;
8382
8383         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8384
8385         // Assert the channel created by node0 is using the override config.
8386         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8387         assert_eq!(res.channel_flags, 0);
8388         assert_eq!(res.to_self_delay, 200);
8389 }
8390
8391 #[test]
8392 fn test_override_0msat_htlc_minimum() {
8393         let mut zero_config = UserConfig::default();
8394         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8395         let chanmon_cfgs = create_chanmon_cfgs(2);
8396         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8397         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8398         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8399
8400         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8401         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8402         assert_eq!(res.htlc_minimum_msat, 1);
8403
8404         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8405         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8406         assert_eq!(res.htlc_minimum_msat, 1);
8407 }
8408
8409 #[test]
8410 fn test_simple_mpp() {
8411         // Simple test of sending a multi-path payment.
8412         let chanmon_cfgs = create_chanmon_cfgs(4);
8413         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8414         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8415         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8416
8417         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8418         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8419         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8420         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8421         let logger = test_utils::TestLogger::new();
8422
8423         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8424         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8425         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8426         let path = route.paths[0].clone();
8427         route.paths.push(path);
8428         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8429         route.paths[0][0].short_channel_id = chan_1_id;
8430         route.paths[0][1].short_channel_id = chan_3_id;
8431         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8432         route.paths[1][0].short_channel_id = chan_2_id;
8433         route.paths[1][1].short_channel_id = chan_4_id;
8434         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8435         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8436 }
8437
8438 #[test]
8439 fn test_preimage_storage() {
8440         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8441         let chanmon_cfgs = create_chanmon_cfgs(2);
8442         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8443         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8444         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8445
8446         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8447
8448         {
8449                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8450
8451                 let logger = test_utils::TestLogger::new();
8452                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8453                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8454                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8455                 check_added_monitors!(nodes[0], 1);
8456                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8457                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8458                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8459                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8460         }
8461         // Note that after leaving the above scope we have no knowledge of any arguments or return
8462         // values from previous calls.
8463         expect_pending_htlcs_forwardable!(nodes[1]);
8464         let events = nodes[1].node.get_and_clear_pending_events();
8465         assert_eq!(events.len(), 1);
8466         match events[0] {
8467                 Event::PaymentReceived { ref purpose, .. } => {
8468                         match &purpose {
8469                                 PaymentPurpose::InvoicePayment { payment_preimage, user_payment_id, .. } => {
8470                                         assert_eq!(*user_payment_id, 42);
8471                                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8472                                 },
8473                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
8474                         }
8475                 },
8476                 _ => panic!("Unexpected event"),
8477         }
8478 }
8479
8480 #[test]
8481 fn test_secret_timeout() {
8482         // Simple test of payment secret storage time outs
8483         let chanmon_cfgs = create_chanmon_cfgs(2);
8484         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8485         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8486         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8487
8488         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8489
8490         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8491
8492         // We should fail to register the same payment hash twice, at least until we've connected a
8493         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8494         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8495                 assert_eq!(err, "Duplicate payment hash");
8496         } else { panic!(); }
8497         let mut block = {
8498                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8499                 Block {
8500                         header: BlockHeader {
8501                                 version: 0x2000000,
8502                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8503                                 merkle_root: Default::default(),
8504                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8505                         txdata: vec![],
8506                 }
8507         };
8508         connect_block(&nodes[1], &block);
8509         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8510                 assert_eq!(err, "Duplicate payment hash");
8511         } else { panic!(); }
8512
8513         // If we then connect the second block, we should be able to register the same payment hash
8514         // again with a different user_payment_id (this time getting a new payment secret).
8515         block.header.prev_blockhash = block.header.block_hash();
8516         block.header.time += 1;
8517         connect_block(&nodes[1], &block);
8518         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8519         assert_ne!(payment_secret_1, our_payment_secret);
8520
8521         {
8522                 let logger = test_utils::TestLogger::new();
8523                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8524                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8525                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8526                 check_added_monitors!(nodes[0], 1);
8527                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8528                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8529                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8530                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8531         }
8532         // Note that after leaving the above scope we have no knowledge of any arguments or return
8533         // values from previous calls.
8534         expect_pending_htlcs_forwardable!(nodes[1]);
8535         let events = nodes[1].node.get_and_clear_pending_events();
8536         assert_eq!(events.len(), 1);
8537         match events[0] {
8538                 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, user_payment_id }, .. } => {
8539                         assert!(payment_preimage.is_none());
8540                         assert_eq!(user_payment_id, 42);
8541                         assert_eq!(payment_secret, our_payment_secret);
8542                         // We don't actually have the payment preimage with which to claim this payment!
8543                 },
8544                 _ => panic!("Unexpected event"),
8545         }
8546 }
8547
8548 #[test]
8549 fn test_bad_secret_hash() {
8550         // Simple test of unregistered payment hash/invalid payment secret handling
8551         let chanmon_cfgs = create_chanmon_cfgs(2);
8552         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8553         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8554         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8555
8556         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8557
8558         let random_payment_hash = PaymentHash([42; 32]);
8559         let random_payment_secret = PaymentSecret([43; 32]);
8560         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8561
8562         let logger = test_utils::TestLogger::new();
8563         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8564         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8565
8566         // All the below cases should end up being handled exactly identically, so we macro the
8567         // resulting events.
8568         macro_rules! handle_unknown_invalid_payment_data {
8569                 () => {
8570                         check_added_monitors!(nodes[0], 1);
8571                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8572                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8573                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8574                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8575
8576                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8577                         // again to process the pending backwards-failure of the HTLC
8578                         expect_pending_htlcs_forwardable!(nodes[1]);
8579                         expect_pending_htlcs_forwardable!(nodes[1]);
8580                         check_added_monitors!(nodes[1], 1);
8581
8582                         // We should fail the payment back
8583                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8584                         match events.pop().unwrap() {
8585                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8586                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8587                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8588                                 },
8589                                 _ => panic!("Unexpected event"),
8590                         }
8591                 }
8592         }
8593
8594         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8595         // Error data is the HTLC value (100,000) and current block height
8596         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8597
8598         // Send a payment with the right payment hash but the wrong payment secret
8599         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8600         handle_unknown_invalid_payment_data!();
8601         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8602
8603         // Send a payment with a random payment hash, but the right payment secret
8604         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8605         handle_unknown_invalid_payment_data!();
8606         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8607
8608         // Send a payment with a random payment hash and random payment secret
8609         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8610         handle_unknown_invalid_payment_data!();
8611         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8612 }
8613
8614 #[test]
8615 fn test_update_err_monitor_lockdown() {
8616         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8617         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8618         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8619         //
8620         // This scenario may happen in a watchtower setup, where watchtower process a block height
8621         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8622         // commitment at same time.
8623
8624         let chanmon_cfgs = create_chanmon_cfgs(2);
8625         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8626         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8627         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8628
8629         // Create some initial channel
8630         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8631         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8632
8633         // Rebalance the network to generate htlc in the two directions
8634         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8635
8636         // Route a HTLC from node 0 to node 1 (but don't settle)
8637         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8638
8639         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8640         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8641         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8642         let persister = test_utils::TestPersister::new();
8643         let watchtower = {
8644                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8645                 let monitor = monitors.get(&outpoint).unwrap();
8646                 let mut w = test_utils::TestVecWriter(Vec::new());
8647                 monitor.write(&mut w).unwrap();
8648                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8649                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8650                 assert!(new_monitor == *monitor);
8651                 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);
8652                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8653                 watchtower
8654         };
8655         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8656         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8657         // transaction lock time requirements here.
8658         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8659         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8660
8661         // Try to update ChannelMonitor
8662         assert!(nodes[1].node.claim_funds(preimage));
8663         check_added_monitors!(nodes[1], 1);
8664         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8665         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8666         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8667         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8668                 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8669                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8670                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8671                 } else { assert!(false); }
8672         } else { assert!(false); };
8673         // Our local monitor is in-sync and hasn't processed yet timeout
8674         check_added_monitors!(nodes[0], 1);
8675         let events = nodes[0].node.get_and_clear_pending_events();
8676         assert_eq!(events.len(), 1);
8677 }
8678
8679 #[test]
8680 fn test_concurrent_monitor_claim() {
8681         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8682         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8683         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8684         // state N+1 confirms. Alice claims output from state N+1.
8685
8686         let chanmon_cfgs = create_chanmon_cfgs(2);
8687         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8688         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8689         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8690
8691         // Create some initial channel
8692         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8693         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8694
8695         // Rebalance the network to generate htlc in the two directions
8696         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8697
8698         // Route a HTLC from node 0 to node 1 (but don't settle)
8699         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8700
8701         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8702         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8703         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8704         let persister = test_utils::TestPersister::new();
8705         let watchtower_alice = {
8706                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8707                 let monitor = monitors.get(&outpoint).unwrap();
8708                 let mut w = test_utils::TestVecWriter(Vec::new());
8709                 monitor.write(&mut w).unwrap();
8710                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8711                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8712                 assert!(new_monitor == *monitor);
8713                 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);
8714                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8715                 watchtower
8716         };
8717         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8718         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8719         // transaction lock time requirements here.
8720         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8721         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8722
8723         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8724         {
8725                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8726                 assert_eq!(txn.len(), 2);
8727                 txn.clear();
8728         }
8729
8730         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8731         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8732         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8733         let persister = test_utils::TestPersister::new();
8734         let watchtower_bob = {
8735                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8736                 let monitor = monitors.get(&outpoint).unwrap();
8737                 let mut w = test_utils::TestVecWriter(Vec::new());
8738                 monitor.write(&mut w).unwrap();
8739                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8740                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8741                 assert!(new_monitor == *monitor);
8742                 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);
8743                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8744                 watchtower
8745         };
8746         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8747         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8748
8749         // Route another payment to generate another update with still previous HTLC pending
8750         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8751         {
8752                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8753                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8754                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8755         }
8756         check_added_monitors!(nodes[1], 1);
8757
8758         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8759         assert_eq!(updates.update_add_htlcs.len(), 1);
8760         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8761         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8762                 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8763                         // Watchtower Alice should already have seen the block and reject the update
8764                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8765                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8766                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8767                 } else { assert!(false); }
8768         } else { assert!(false); };
8769         // Our local monitor is in-sync and hasn't processed yet timeout
8770         check_added_monitors!(nodes[0], 1);
8771
8772         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8773         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8774         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8775
8776         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8777         let bob_state_y;
8778         {
8779                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8780                 assert_eq!(txn.len(), 2);
8781                 bob_state_y = txn[0].clone();
8782                 txn.clear();
8783         };
8784
8785         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8786         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8787         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);
8788         {
8789                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8790                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8791                 // the onchain detection of the HTLC output
8792                 assert_eq!(htlc_txn.len(), 2);
8793                 check_spends!(htlc_txn[0], bob_state_y);
8794                 check_spends!(htlc_txn[1], bob_state_y);
8795         }
8796 }
8797
8798 #[test]
8799 fn test_pre_lockin_no_chan_closed_update() {
8800         // Test that if a peer closes a channel in response to a funding_created message we don't
8801         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8802         // message).
8803         //
8804         // Doing so would imply a channel monitor update before the initial channel monitor
8805         // registration, violating our API guarantees.
8806         //
8807         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8808         // then opening a second channel with the same funding output as the first (which is not
8809         // rejected because the first channel does not exist in the ChannelManager) and closing it
8810         // before receiving funding_signed.
8811         let chanmon_cfgs = create_chanmon_cfgs(2);
8812         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8813         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8814         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8815
8816         // Create an initial channel
8817         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8818         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8819         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8820         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8821         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8822
8823         // Move the first channel through the funding flow...
8824         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8825
8826         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8827         check_added_monitors!(nodes[0], 0);
8828
8829         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8830         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8831         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8832         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8833         check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Hi".to_string() });
8834 }
8835
8836 #[test]
8837 fn test_htlc_no_detection() {
8838         // This test is a mutation to underscore the detection logic bug we had
8839         // before #653. HTLC value routed is above the remaining balance, thus
8840         // inverting HTLC and `to_remote` output. HTLC will come second and
8841         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8842         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8843         // outputs order detection for correct spending children filtring.
8844
8845         let chanmon_cfgs = create_chanmon_cfgs(2);
8846         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8847         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8848         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8849
8850         // Create some initial channels
8851         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8852
8853         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8854         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8855         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8856         assert_eq!(local_txn[0].input.len(), 1);
8857         assert_eq!(local_txn[0].output.len(), 3);
8858         check_spends!(local_txn[0], chan_1.3);
8859
8860         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8861         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8862         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8863         // We deliberately connect the local tx twice as this should provoke a failure calling
8864         // this test before #653 fix.
8865         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);
8866         check_closed_broadcast!(nodes[0], true);
8867         check_added_monitors!(nodes[0], 1);
8868         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
8869         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8870
8871         let htlc_timeout = {
8872                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8873                 assert_eq!(node_txn[1].input.len(), 1);
8874                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8875                 check_spends!(node_txn[1], local_txn[0]);
8876                 node_txn[1].clone()
8877         };
8878
8879         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8880         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8881         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8882         expect_payment_failed!(nodes[0], our_payment_hash, true);
8883 }
8884
8885 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8886         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8887         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8888         // Carol, Alice would be the upstream node, and Carol the downstream.)
8889         //
8890         // Steps of the test:
8891         // 1) Alice sends a HTLC to Carol through Bob.
8892         // 2) Carol doesn't settle the HTLC.
8893         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8894         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8895         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8896         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8897         // 5) Carol release the preimage to Bob off-chain.
8898         // 6) Bob claims the offered output on the broadcasted commitment.
8899         let chanmon_cfgs = create_chanmon_cfgs(3);
8900         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8901         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8902         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8903
8904         // Create some initial channels
8905         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8906         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8907
8908         // Steps (1) and (2):
8909         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8910         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8911
8912         // Check that Alice's commitment transaction now contains an output for this HTLC.
8913         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8914         check_spends!(alice_txn[0], chan_ab.3);
8915         assert_eq!(alice_txn[0].output.len(), 2);
8916         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8917         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8918         assert_eq!(alice_txn.len(), 2);
8919
8920         // Steps (3) and (4):
8921         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8922         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8923         let mut force_closing_node = 0; // Alice force-closes
8924         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8925         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8926         check_closed_broadcast!(nodes[force_closing_node], true);
8927         check_added_monitors!(nodes[force_closing_node], 1);
8928         check_closed_event!(nodes[force_closing_node], 1, ClosureReason::HolderForceClosed);
8929         if go_onchain_before_fulfill {
8930                 let txn_to_broadcast = match broadcast_alice {
8931                         true => alice_txn.clone(),
8932                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8933                 };
8934                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8935                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8936                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8937                 if broadcast_alice {
8938                         check_closed_broadcast!(nodes[1], true);
8939                         check_added_monitors!(nodes[1], 1);
8940                         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
8941                 }
8942                 assert_eq!(bob_txn.len(), 1);
8943                 check_spends!(bob_txn[0], chan_ab.3);
8944         }
8945
8946         // Step (5):
8947         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8948         // process of removing the HTLC from their commitment transactions.
8949         assert!(nodes[2].node.claim_funds(payment_preimage));
8950         check_added_monitors!(nodes[2], 1);
8951         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8952         assert!(carol_updates.update_add_htlcs.is_empty());
8953         assert!(carol_updates.update_fail_htlcs.is_empty());
8954         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8955         assert!(carol_updates.update_fee.is_none());
8956         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8957
8958         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8959         expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
8960         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8961         if !go_onchain_before_fulfill && broadcast_alice {
8962                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8963                 assert_eq!(events.len(), 1);
8964                 match events[0] {
8965                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8966                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8967                         },
8968                         _ => panic!("Unexpected event"),
8969                 };
8970         }
8971         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8972         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8973         // Carol<->Bob's updated commitment transaction info.
8974         check_added_monitors!(nodes[1], 2);
8975
8976         let events = nodes[1].node.get_and_clear_pending_msg_events();
8977         assert_eq!(events.len(), 2);
8978         let bob_revocation = match events[0] {
8979                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8980                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8981                         (*msg).clone()
8982                 },
8983                 _ => panic!("Unexpected event"),
8984         };
8985         let bob_updates = match events[1] {
8986                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8987                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8988                         (*updates).clone()
8989                 },
8990                 _ => panic!("Unexpected event"),
8991         };
8992
8993         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8994         check_added_monitors!(nodes[2], 1);
8995         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8996         check_added_monitors!(nodes[2], 1);
8997
8998         let events = nodes[2].node.get_and_clear_pending_msg_events();
8999         assert_eq!(events.len(), 1);
9000         let carol_revocation = match events[0] {
9001                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
9002                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
9003                         (*msg).clone()
9004                 },
9005                 _ => panic!("Unexpected event"),
9006         };
9007         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
9008         check_added_monitors!(nodes[1], 1);
9009
9010         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
9011         // here's where we put said channel's commitment tx on-chain.
9012         let mut txn_to_broadcast = alice_txn.clone();
9013         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
9014         if !go_onchain_before_fulfill {
9015                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
9016                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
9017                 // If Bob was the one to force-close, he will have already passed these checks earlier.
9018                 if broadcast_alice {
9019                         check_closed_broadcast!(nodes[1], true);
9020                         check_added_monitors!(nodes[1], 1);
9021                         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
9022                 }
9023                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
9024                 if broadcast_alice {
9025                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
9026                         // new block being connected. The ChannelManager being notified triggers a monitor update,
9027                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
9028                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
9029                         // broadcasted.
9030                         assert_eq!(bob_txn.len(), 3);
9031                         check_spends!(bob_txn[1], chan_ab.3);
9032                 } else {
9033                         assert_eq!(bob_txn.len(), 2);
9034                         check_spends!(bob_txn[0], chan_ab.3);
9035                 }
9036         }
9037
9038         // Step (6):
9039         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
9040         // broadcasted commitment transaction.
9041         {
9042                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
9043                 if go_onchain_before_fulfill {
9044                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
9045                         assert_eq!(bob_txn.len(), 2);
9046                 }
9047                 let script_weight = match broadcast_alice {
9048                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
9049                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
9050                 };
9051                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
9052                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
9053                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
9054                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
9055                 if broadcast_alice && !go_onchain_before_fulfill {
9056                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
9057                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
9058                 } else {
9059                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
9060                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
9061                 }
9062         }
9063 }
9064
9065 #[test]
9066 fn test_onchain_htlc_settlement_after_close() {
9067         do_test_onchain_htlc_settlement_after_close(true, true);
9068         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
9069         do_test_onchain_htlc_settlement_after_close(true, false);
9070         do_test_onchain_htlc_settlement_after_close(false, false);
9071 }
9072
9073 #[test]
9074 fn test_duplicate_chan_id() {
9075         // Test that if a given peer tries to open a channel with the same channel_id as one that is
9076         // already open we reject it and keep the old channel.
9077         //
9078         // Previously, full_stack_target managed to figure out that if you tried to open two channels
9079         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
9080         // the existing channel when we detect the duplicate new channel, screwing up our monitor
9081         // updating logic for the existing channel.
9082         let chanmon_cfgs = create_chanmon_cfgs(2);
9083         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9084         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9085         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9086
9087         // Create an initial channel
9088         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9089         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9090         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9091         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()));
9092
9093         // Try to create a second channel with the same temporary_channel_id as the first and check
9094         // that it is rejected.
9095         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9096         {
9097                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9098                 assert_eq!(events.len(), 1);
9099                 match events[0] {
9100                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9101                                 // Technically, at this point, nodes[1] would be justified in thinking both the
9102                                 // first (valid) and second (invalid) channels are closed, given they both have
9103                                 // the same non-temporary channel_id. However, currently we do not, so we just
9104                                 // move forward with it.
9105                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9106                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9107                         },
9108                         _ => panic!("Unexpected event"),
9109                 }
9110         }
9111
9112         // Move the first channel through the funding flow...
9113         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
9114
9115         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9116         check_added_monitors!(nodes[0], 0);
9117
9118         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9119         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
9120         {
9121                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9122                 assert_eq!(added_monitors.len(), 1);
9123                 assert_eq!(added_monitors[0].0, funding_output);
9124                 added_monitors.clear();
9125         }
9126         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
9127
9128         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
9129         let channel_id = funding_outpoint.to_channel_id();
9130
9131         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
9132         // temporary one).
9133
9134         // First try to open a second channel with a temporary channel id equal to the txid-based one.
9135         // Technically this is allowed by the spec, but we don't support it and there's little reason
9136         // to. Still, it shouldn't cause any other issues.
9137         open_chan_msg.temporary_channel_id = channel_id;
9138         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
9139         {
9140                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9141                 assert_eq!(events.len(), 1);
9142                 match events[0] {
9143                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9144                                 // Technically, at this point, nodes[1] would be justified in thinking both
9145                                 // channels are closed, but currently we do not, so we just move forward with it.
9146                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
9147                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9148                         },
9149                         _ => panic!("Unexpected event"),
9150                 }
9151         }
9152
9153         // Now try to create a second channel which has a duplicate funding output.
9154         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
9155         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9156         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
9157         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()));
9158         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
9159
9160         let funding_created = {
9161                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
9162                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
9163                 let logger = test_utils::TestLogger::new();
9164                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
9165         };
9166         check_added_monitors!(nodes[0], 0);
9167         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
9168         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
9169         // still needs to be cleared here.
9170         check_added_monitors!(nodes[1], 1);
9171
9172         // ...still, nodes[1] will reject the duplicate channel.
9173         {
9174                 let events = nodes[1].node.get_and_clear_pending_msg_events();
9175                 assert_eq!(events.len(), 1);
9176                 match events[0] {
9177                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
9178                                 // Technically, at this point, nodes[1] would be justified in thinking both
9179                                 // channels are closed, but currently we do not, so we just move forward with it.
9180                                 assert_eq!(msg.channel_id, channel_id);
9181                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
9182                         },
9183                         _ => panic!("Unexpected event"),
9184                 }
9185         }
9186
9187         // finally, finish creating the original channel and send a payment over it to make sure
9188         // everything is functional.
9189         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
9190         {
9191                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9192                 assert_eq!(added_monitors.len(), 1);
9193                 assert_eq!(added_monitors[0].0, funding_output);
9194                 added_monitors.clear();
9195         }
9196
9197         let events_4 = nodes[0].node.get_and_clear_pending_events();
9198         assert_eq!(events_4.len(), 0);
9199         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9200         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
9201
9202         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9203         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9204         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9205         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9206 }
9207
9208 #[test]
9209 fn test_error_chans_closed() {
9210         // Test that we properly handle error messages, closing appropriate channels.
9211         //
9212         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9213         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9214         // we can test various edge cases around it to ensure we don't regress.
9215         let chanmon_cfgs = create_chanmon_cfgs(3);
9216         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9217         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9218         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9219
9220         // Create some initial channels
9221         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9222         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9223         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9224
9225         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9226         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9227         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9228
9229         // Closing a channel from a different peer has no effect
9230         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9231         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9232
9233         // Closing one channel doesn't impact others
9234         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9235         check_added_monitors!(nodes[0], 1);
9236         check_closed_broadcast!(nodes[0], false);
9237         check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
9238         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9239         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9240         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);
9241         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);
9242
9243         // A null channel ID should close all channels
9244         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9245         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9246         check_added_monitors!(nodes[0], 2);
9247         check_closed_event!(nodes[0], 2, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
9248         let events = nodes[0].node.get_and_clear_pending_msg_events();
9249         assert_eq!(events.len(), 2);
9250         match events[0] {
9251                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9252                         assert_eq!(msg.contents.flags & 2, 2);
9253                 },
9254                 _ => panic!("Unexpected event"),
9255         }
9256         match events[1] {
9257                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9258                         assert_eq!(msg.contents.flags & 2, 2);
9259                 },
9260                 _ => panic!("Unexpected event"),
9261         }
9262         // Note that at this point users of a standard PeerHandler will end up calling
9263         // peer_disconnected with no_connection_possible set to false, duplicating the
9264         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9265         // users with their own peer handling logic. We duplicate the call here, however.
9266         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9267         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9268
9269         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9270         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9271         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9272 }
9273
9274 #[test]
9275 fn test_invalid_funding_tx() {
9276         // Test that we properly handle invalid funding transactions sent to us from a peer.
9277         //
9278         // Previously, all other major lightning implementations had failed to properly sanitize
9279         // funding transactions from their counterparties, leading to a multi-implementation critical
9280         // security vulnerability (though we always sanitized properly, we've previously had
9281         // un-released crashes in the sanitization process).
9282         let chanmon_cfgs = create_chanmon_cfgs(2);
9283         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9284         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9285         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9286
9287         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9288         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()));
9289         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()));
9290
9291         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9292         for output in tx.output.iter_mut() {
9293                 // Make the confirmed funding transaction have a bogus script_pubkey
9294                 output.script_pubkey = bitcoin::Script::new();
9295         }
9296
9297         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9298         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()));
9299         check_added_monitors!(nodes[1], 1);
9300
9301         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()));
9302         check_added_monitors!(nodes[0], 1);
9303
9304         let events_1 = nodes[0].node.get_and_clear_pending_events();
9305         assert_eq!(events_1.len(), 0);
9306
9307         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9308         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9309         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9310
9311         confirm_transaction_at(&nodes[1], &tx, 1);
9312         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
9313         check_added_monitors!(nodes[1], 1);
9314         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9315         assert_eq!(events_2.len(), 1);
9316         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9317                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9318                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9319                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9320                 } else { panic!(); }
9321         } else { panic!(); }
9322         assert_eq!(nodes[1].node.list_channels().len(), 0);
9323 }
9324
9325 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9326         // In the first version of the chain::Confirm interface, after a refactor was made to not
9327         // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9328         // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9329         // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9330         // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9331         // spending transaction until height N+1 (or greater). This was due to the way
9332         // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9333         // spending transaction at the height the input transaction was confirmed at, not whether we
9334         // should broadcast a spending transaction at the current height.
9335         // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9336         // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9337         // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9338         // until we learned about an additional block.
9339         //
9340         // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9341         // aren't broadcasting transactions too early (ie not broadcasting them at all).
9342         let chanmon_cfgs = create_chanmon_cfgs(3);
9343         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9344         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9345         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9346         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9347
9348         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9349         let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9350         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9351         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9352         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9353
9354         nodes[1].node.force_close_channel(&channel_id).unwrap();
9355         check_closed_broadcast!(nodes[1], true);
9356         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
9357         check_added_monitors!(nodes[1], 1);
9358         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9359         assert_eq!(node_txn.len(), 1);
9360
9361         let conf_height = nodes[1].best_block_info().1;
9362         if !test_height_before_timelock {
9363                 connect_blocks(&nodes[1], 24 * 6);
9364         }
9365         nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9366                 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9367         if test_height_before_timelock {
9368                 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9369                 // generate any events or broadcast any transactions
9370                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9371                 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9372         } else {
9373                 // We should broadcast an HTLC transaction spending our funding transaction first
9374                 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9375                 assert_eq!(spending_txn.len(), 2);
9376                 assert_eq!(spending_txn[0], node_txn[0]);
9377                 check_spends!(spending_txn[1], node_txn[0]);
9378                 // We should also generate a SpendableOutputs event with the to_self output (as its
9379                 // timelock is up).
9380                 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9381                 assert_eq!(descriptor_spend_txn.len(), 1);
9382
9383                 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9384                 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9385                 // additional block built on top of the current chain.
9386                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9387                         &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9388                 expect_pending_htlcs_forwardable!(nodes[1]);
9389                 check_added_monitors!(nodes[1], 1);
9390
9391                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9392                 assert!(updates.update_add_htlcs.is_empty());
9393                 assert!(updates.update_fulfill_htlcs.is_empty());
9394                 assert_eq!(updates.update_fail_htlcs.len(), 1);
9395                 assert!(updates.update_fail_malformed_htlcs.is_empty());
9396                 assert!(updates.update_fee.is_none());
9397                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9398                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9399                 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_announce.contents.short_channel_id, true);
9400         }
9401 }
9402
9403 #[test]
9404 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9405         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9406         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9407 }
9408
9409 #[test]
9410 fn test_forwardable_regen() {
9411         // Tests that if we reload a ChannelManager while forwards are pending we will regenerate the
9412         // PendingHTLCsForwardable event automatically, ensuring we don't forget to forward/receive
9413         // HTLCs.
9414         // We test it for both payment receipt and payment forwarding.
9415
9416         let chanmon_cfgs = create_chanmon_cfgs(3);
9417         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9418         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9419         let persister: test_utils::TestPersister;
9420         let new_chain_monitor: test_utils::TestChainMonitor;
9421         let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
9422         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9423         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9424         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9425
9426         // First send a payment to nodes[1]
9427         let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
9428         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
9429         check_added_monitors!(nodes[0], 1);
9430
9431         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9432         assert_eq!(events.len(), 1);
9433         let payment_event = SendEvent::from_event(events.pop().unwrap());
9434         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9435         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9436
9437         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
9438
9439         // Next send a payment which is forwarded by nodes[1]
9440         let (route_2, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 200_000);
9441         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
9442         check_added_monitors!(nodes[0], 1);
9443
9444         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9445         assert_eq!(events.len(), 1);
9446         let payment_event = SendEvent::from_event(events.pop().unwrap());
9447         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9448         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
9449
9450         // There is already a PendingHTLCsForwardable event "pending" so another one will not be
9451         // generated
9452         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
9453
9454         // Now restart nodes[1] and make sure it regenerates a single PendingHTLCsForwardable
9455         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9456         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9457
9458         let nodes_1_serialized = nodes[1].node.encode();
9459         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
9460         let mut chan_1_monitor_serialized = test_utils::TestVecWriter(Vec::new());
9461         {
9462                 let monitors = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
9463                 let mut monitor_iter = monitors.iter();
9464                 monitor_iter.next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
9465                 monitor_iter.next().unwrap().1.write(&mut chan_1_monitor_serialized).unwrap();
9466         }
9467
9468         persister = test_utils::TestPersister::new();
9469         let keys_manager = &chanmon_cfgs[1].keys_manager;
9470         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger, node_cfgs[1].fee_estimator, &persister, keys_manager);
9471         nodes[1].chain_monitor = &new_chain_monitor;
9472
9473         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
9474         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
9475                 &mut chan_0_monitor_read, keys_manager).unwrap();
9476         assert!(chan_0_monitor_read.is_empty());
9477         let mut chan_1_monitor_read = &chan_1_monitor_serialized.0[..];
9478         let (_, mut chan_1_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
9479                 &mut chan_1_monitor_read, keys_manager).unwrap();
9480         assert!(chan_1_monitor_read.is_empty());
9481
9482         let mut nodes_1_read = &nodes_1_serialized[..];
9483         let (_, nodes_1_deserialized_tmp) = {
9484                 let mut channel_monitors = HashMap::new();
9485                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
9486                 channel_monitors.insert(chan_1_monitor.get_funding_txo().0, &mut chan_1_monitor);
9487                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
9488                         default_config: UserConfig::default(),
9489                         keys_manager,
9490                         fee_estimator: node_cfgs[1].fee_estimator,
9491                         chain_monitor: nodes[1].chain_monitor,
9492                         tx_broadcaster: nodes[1].tx_broadcaster.clone(),
9493                         logger: nodes[1].logger,
9494                         channel_monitors,
9495                 }).unwrap()
9496         };
9497         nodes_1_deserialized = nodes_1_deserialized_tmp;
9498         assert!(nodes_1_read.is_empty());
9499
9500         assert!(nodes[1].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
9501         assert!(nodes[1].chain_monitor.watch_channel(chan_1_monitor.get_funding_txo().0, chan_1_monitor).is_ok());
9502         nodes[1].node = &nodes_1_deserialized;
9503         check_added_monitors!(nodes[1], 2);
9504
9505         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
9506         // Note that nodes[1] and nodes[2] resend their funding_locked here since they haven't updated
9507         // the commitment state.
9508         reconnect_nodes(&nodes[1], &nodes[2], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
9509
9510         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
9511
9512         expect_pending_htlcs_forwardable!(nodes[1]);
9513         expect_payment_received!(nodes[1], payment_hash, payment_secret, 100_000);
9514         check_added_monitors!(nodes[1], 1);
9515
9516         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
9517         assert_eq!(events.len(), 1);
9518         let payment_event = SendEvent::from_event(events.pop().unwrap());
9519         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
9520         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false);
9521         expect_pending_htlcs_forwardable!(nodes[2]);
9522         expect_payment_received!(nodes[2], payment_hash_2, payment_secret_2, 200_000);
9523
9524         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
9525         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
9526 }
9527
9528 #[test]
9529 fn test_keysend_payments_to_public_node() {
9530         let chanmon_cfgs = create_chanmon_cfgs(2);
9531         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9532         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9533         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9534
9535         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9536         let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9537         let payer_pubkey = nodes[0].node.get_our_node_id();
9538         let payee_pubkey = nodes[1].node.get_our_node_id();
9539         let route = get_route(&payer_pubkey, network_graph, &payee_pubkey, None,
9540                         None, &vec![], 10000, 40,
9541                         nodes[0].logger).unwrap();
9542
9543         let test_preimage = PaymentPreimage([42; 32]);
9544         let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9545         check_added_monitors!(nodes[0], 1);
9546         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9547         assert_eq!(events.len(), 1);
9548         let event = events.pop().unwrap();
9549         let path = vec![&nodes[1]];
9550         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9551         claim_payment(&nodes[0], &path, test_preimage);
9552 }
9553
9554 #[test]
9555 fn test_keysend_payments_to_private_node() {
9556         let chanmon_cfgs = create_chanmon_cfgs(2);
9557         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9558         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9559         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9560
9561         let payer_pubkey = nodes[0].node.get_our_node_id();
9562         let payee_pubkey = nodes[1].node.get_our_node_id();
9563         nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
9564         nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
9565
9566         let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
9567         let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9568         let first_hops = nodes[0].node.list_usable_channels();
9569         let route = get_keysend_route(&payer_pubkey, &network_graph, &payee_pubkey,
9570                                 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
9571                                 nodes[0].logger).unwrap();
9572
9573         let test_preimage = PaymentPreimage([42; 32]);
9574         let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9575         check_added_monitors!(nodes[0], 1);
9576         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9577         assert_eq!(events.len(), 1);
9578         let event = events.pop().unwrap();
9579         let path = vec![&nodes[1]];
9580         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9581         claim_payment(&nodes[0], &path, test_preimage);
9582 }