]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/functional_tests.rs
f drop spurious test changes
[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, MppId, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
23 use ln::channel::{Channel, ChannelError};
24 use ln::{chan_utils, onion_utils};
25 use ln::chan_utils::HTLC_SUCCESS_TX_WEIGHT;
26 use routing::router::{Route, RouteHop, RouteHint, RouteHintHop, get_route, get_keysend_route};
27 use routing::network_graph::{NetworkUpdate, RoutingFees};
28 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
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::CommitmentTxBroadcasted);
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_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::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
2200         check_closed_event!(nodes[4], 1, ClosureReason::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
2381                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2382                 check_added_monitors!(nodes[1], 1);
2383                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted, .. } => {}
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::CommitmentTxBroadcasted);
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 { .. } => {}
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::CommitmentTxBroadcasted);
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 { .. } => {},
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::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
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::CommitmentTxBroadcasted);
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 { .. } => { },
3020                 _ => panic!("Unexepected event"),
3021         }
3022         match events[1] {
3023                 Event::PaymentFailed { 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::PaymentFailed { 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::PaymentFailed { 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::PaymentFailed { 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::PaymentFailed { payment_hash, .. } => {
3194                         assert_eq!(payment_hash, failed_payment_hash);
3195                 },
3196                 _ => panic!("Unexpected event"),
3197         }
3198         match events[1] {
3199                 Event::ChannelClosed { .. } => {}
3200                 _ => panic!("Unexpected event"),
3201         }
3202         check_closed_broadcast!(nodes[0], true);
3203         check_added_monitors!(nodes[0], 1);
3204 }
3205
3206 #[test]
3207 fn test_htlc_ignore_latest_remote_commitment() {
3208         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3209         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3210         let chanmon_cfgs = create_chanmon_cfgs(2);
3211         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3212         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3213         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3214         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3215
3216         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3217         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3218         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3219         check_closed_broadcast!(nodes[0], true);
3220         check_added_monitors!(nodes[0], 1);
3221         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
3222
3223         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3224         assert_eq!(node_txn.len(), 3);
3225         assert_eq!(node_txn[0], node_txn[1]);
3226
3227         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3228         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3229         check_closed_broadcast!(nodes[1], true);
3230         check_added_monitors!(nodes[1], 1);
3231         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
3232
3233         // Duplicate the connect_block call since this may happen due to other listeners
3234         // registering new transactions
3235         header.prev_blockhash = header.block_hash();
3236         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3237 }
3238
3239 #[test]
3240 fn test_force_close_fail_back() {
3241         // Check which HTLCs are failed-backwards on channel force-closure
3242         let chanmon_cfgs = create_chanmon_cfgs(3);
3243         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3244         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3245         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3246         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3247         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3248         let logger = test_utils::TestLogger::new();
3249
3250         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3251
3252         let mut payment_event = {
3253                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3254                 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();
3255                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3256                 check_added_monitors!(nodes[0], 1);
3257
3258                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3259                 assert_eq!(events.len(), 1);
3260                 SendEvent::from_event(events.remove(0))
3261         };
3262
3263         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3264         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3265
3266         expect_pending_htlcs_forwardable!(nodes[1]);
3267
3268         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3269         assert_eq!(events_2.len(), 1);
3270         payment_event = SendEvent::from_event(events_2.remove(0));
3271         assert_eq!(payment_event.msgs.len(), 1);
3272
3273         check_added_monitors!(nodes[1], 1);
3274         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3275         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3276         check_added_monitors!(nodes[2], 1);
3277         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3278
3279         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3280         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3281         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3282
3283         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3284         check_closed_broadcast!(nodes[2], true);
3285         check_added_monitors!(nodes[2], 1);
3286         check_closed_event!(nodes[2], 1, ClosureReason::HolderForceClosed);
3287         let tx = {
3288                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3289                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3290                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3291                 // back to nodes[1] upon timeout otherwise.
3292                 assert_eq!(node_txn.len(), 1);
3293                 node_txn.remove(0)
3294         };
3295
3296         mine_transaction(&nodes[1], &tx);
3297
3298         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3299         check_closed_broadcast!(nodes[1], true);
3300         check_added_monitors!(nodes[1], 1);
3301         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
3302
3303         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3304         {
3305                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3306                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3307                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3308         }
3309         mine_transaction(&nodes[2], &tx);
3310         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3311         assert_eq!(node_txn.len(), 1);
3312         assert_eq!(node_txn[0].input.len(), 1);
3313         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3314         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3315         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3316
3317         check_spends!(node_txn[0], tx);
3318 }
3319
3320 #[test]
3321 fn test_dup_events_on_peer_disconnect() {
3322         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3323         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3324         // as we used to generate the event immediately upon receipt of the payment preimage in the
3325         // update_fulfill_htlc message.
3326
3327         let chanmon_cfgs = create_chanmon_cfgs(2);
3328         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3329         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3330         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3331         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3332
3333         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 1000000).0;
3334
3335         assert!(nodes[1].node.claim_funds(payment_preimage));
3336         check_added_monitors!(nodes[1], 1);
3337         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3338         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3339         expect_payment_sent!(nodes[0], payment_preimage);
3340
3341         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3342         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3343
3344         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3345         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3346 }
3347
3348 #[test]
3349 fn test_simple_peer_disconnect() {
3350         // Test that we can reconnect when there are no lost messages
3351         let chanmon_cfgs = create_chanmon_cfgs(3);
3352         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3353         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3354         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3355         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3356         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3357
3358         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3359         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3360         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3361
3362         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3363         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3364         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3365         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3366
3367         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3368         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3369         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3370
3371         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3372         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3373         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3374         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3375
3376         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3377         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3378
3379         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3380         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_hash_5);
3381
3382         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3383         {
3384                 let events = nodes[0].node.get_and_clear_pending_events();
3385                 assert_eq!(events.len(), 2);
3386                 match events[0] {
3387                         Event::PaymentSent { payment_preimage } => {
3388                                 assert_eq!(payment_preimage, payment_preimage_3);
3389                         },
3390                         _ => panic!("Unexpected event"),
3391                 }
3392                 match events[1] {
3393                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3394                                 assert_eq!(payment_hash, payment_hash_5);
3395                                 assert!(rejected_by_dest);
3396                         },
3397                         _ => panic!("Unexpected event"),
3398                 }
3399         }
3400
3401         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3402         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3403 }
3404
3405 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3406         // Test that we can reconnect when in-flight HTLC updates get dropped
3407         let chanmon_cfgs = create_chanmon_cfgs(2);
3408         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3409         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3410         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3411
3412         let mut as_funding_locked = None;
3413         if messages_delivered == 0 {
3414                 let (funding_locked, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3415                 as_funding_locked = Some(funding_locked);
3416                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3417                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3418                 // it before the channel_reestablish message.
3419         } else {
3420                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3421         }
3422
3423         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3424
3425         let logger = test_utils::TestLogger::new();
3426         let payment_event = {
3427                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3428                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3429                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3430                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3431                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3432                 check_added_monitors!(nodes[0], 1);
3433
3434                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3435                 assert_eq!(events.len(), 1);
3436                 SendEvent::from_event(events.remove(0))
3437         };
3438         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3439
3440         if messages_delivered < 2 {
3441                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3442         } else {
3443                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3444                 if messages_delivered >= 3 {
3445                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3446                         check_added_monitors!(nodes[1], 1);
3447                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3448
3449                         if messages_delivered >= 4 {
3450                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3451                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3452                                 check_added_monitors!(nodes[0], 1);
3453
3454                                 if messages_delivered >= 5 {
3455                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3456                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3457                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3458                                         check_added_monitors!(nodes[0], 1);
3459
3460                                         if messages_delivered >= 6 {
3461                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3462                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3463                                                 check_added_monitors!(nodes[1], 1);
3464                                         }
3465                                 }
3466                         }
3467                 }
3468         }
3469
3470         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3471         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3472         if messages_delivered < 3 {
3473                 if simulate_broken_lnd {
3474                         // lnd has a long-standing bug where they send a funding_locked prior to a
3475                         // channel_reestablish if you reconnect prior to funding_locked time.
3476                         //
3477                         // Here we simulate that behavior, delivering a funding_locked immediately on
3478                         // reconnect. Note that we don't bother skipping the now-duplicate funding_locked sent
3479                         // in `reconnect_nodes` but we currently don't fail based on that.
3480                         //
3481                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3482                         nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding_locked.as_ref().unwrap().0);
3483                 }
3484                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3485                 // received on either side, both sides will need to resend them.
3486                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3487         } else if messages_delivered == 3 {
3488                 // nodes[0] still wants its RAA + commitment_signed
3489                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3490         } else if messages_delivered == 4 {
3491                 // nodes[0] still wants its commitment_signed
3492                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3493         } else if messages_delivered == 5 {
3494                 // nodes[1] still wants its final RAA
3495                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3496         } else if messages_delivered == 6 {
3497                 // Everything was delivered...
3498                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3499         }
3500
3501         let events_1 = nodes[1].node.get_and_clear_pending_events();
3502         assert_eq!(events_1.len(), 1);
3503         match events_1[0] {
3504                 Event::PendingHTLCsForwardable { .. } => { },
3505                 _ => panic!("Unexpected event"),
3506         };
3507
3508         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3509         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3510         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3511
3512         nodes[1].node.process_pending_htlc_forwards();
3513
3514         let events_2 = nodes[1].node.get_and_clear_pending_events();
3515         assert_eq!(events_2.len(), 1);
3516         match events_2[0] {
3517                 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
3518                         assert_eq!(payment_hash_1, *payment_hash);
3519                         assert_eq!(amt, 1000000);
3520                         match &purpose {
3521                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3522                                         assert!(payment_preimage.is_none());
3523                                         assert_eq!(payment_secret_1, *payment_secret);
3524                                 },
3525                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3526                         }
3527                 },
3528                 _ => panic!("Unexpected event"),
3529         }
3530
3531         nodes[1].node.claim_funds(payment_preimage_1);
3532         check_added_monitors!(nodes[1], 1);
3533
3534         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3535         assert_eq!(events_3.len(), 1);
3536         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3537                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3538                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3539                         assert!(updates.update_add_htlcs.is_empty());
3540                         assert!(updates.update_fail_htlcs.is_empty());
3541                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3542                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3543                         assert!(updates.update_fee.is_none());
3544                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3545                 },
3546                 _ => panic!("Unexpected event"),
3547         };
3548
3549         if messages_delivered >= 1 {
3550                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3551
3552                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3553                 assert_eq!(events_4.len(), 1);
3554                 match events_4[0] {
3555                         Event::PaymentSent { ref payment_preimage } => {
3556                                 assert_eq!(payment_preimage_1, *payment_preimage);
3557                         },
3558                         _ => panic!("Unexpected event"),
3559                 }
3560
3561                 if messages_delivered >= 2 {
3562                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3563                         check_added_monitors!(nodes[0], 1);
3564                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3565
3566                         if messages_delivered >= 3 {
3567                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3568                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3569                                 check_added_monitors!(nodes[1], 1);
3570
3571                                 if messages_delivered >= 4 {
3572                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3573                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3574                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3575                                         check_added_monitors!(nodes[1], 1);
3576
3577                                         if messages_delivered >= 5 {
3578                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3579                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3580                                                 check_added_monitors!(nodes[0], 1);
3581                                         }
3582                                 }
3583                         }
3584                 }
3585         }
3586
3587         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3588         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3589         if messages_delivered < 2 {
3590                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3591                 if messages_delivered < 1 {
3592                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3593                         assert_eq!(events_4.len(), 1);
3594                         match events_4[0] {
3595                                 Event::PaymentSent { ref payment_preimage } => {
3596                                         assert_eq!(payment_preimage_1, *payment_preimage);
3597                                 },
3598                                 _ => panic!("Unexpected event"),
3599                         }
3600                 } else {
3601                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3602                 }
3603         } else if messages_delivered == 2 {
3604                 // nodes[0] still wants its RAA + commitment_signed
3605                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3606         } else if messages_delivered == 3 {
3607                 // nodes[0] still wants its commitment_signed
3608                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3609         } else if messages_delivered == 4 {
3610                 // nodes[1] still wants its final RAA
3611                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3612         } else if messages_delivered == 5 {
3613                 // Everything was delivered...
3614                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3615         }
3616
3617         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3618         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3619         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3620
3621         // Channel should still work fine...
3622         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3623         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph,
3624                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3625                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3626         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3627         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3628 }
3629
3630 #[test]
3631 fn test_drop_messages_peer_disconnect_a() {
3632         do_test_drop_messages_peer_disconnect(0, true);
3633         do_test_drop_messages_peer_disconnect(0, false);
3634         do_test_drop_messages_peer_disconnect(1, false);
3635         do_test_drop_messages_peer_disconnect(2, false);
3636 }
3637
3638 #[test]
3639 fn test_drop_messages_peer_disconnect_b() {
3640         do_test_drop_messages_peer_disconnect(3, false);
3641         do_test_drop_messages_peer_disconnect(4, false);
3642         do_test_drop_messages_peer_disconnect(5, false);
3643         do_test_drop_messages_peer_disconnect(6, false);
3644 }
3645
3646 #[test]
3647 fn test_funding_peer_disconnect() {
3648         // Test that we can lock in our funding tx while disconnected
3649         let chanmon_cfgs = create_chanmon_cfgs(2);
3650         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3651         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3652         let persister: test_utils::TestPersister;
3653         let new_chain_monitor: test_utils::TestChainMonitor;
3654         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
3655         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3656         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3657
3658         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3659         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3660
3661         confirm_transaction(&nodes[0], &tx);
3662         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3663         assert_eq!(events_1.len(), 1);
3664         match events_1[0] {
3665                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3666                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3667                 },
3668                 _ => panic!("Unexpected event"),
3669         }
3670
3671         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3672
3673         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3674         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3675
3676         confirm_transaction(&nodes[1], &tx);
3677         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3678         assert_eq!(events_2.len(), 2);
3679         let funding_locked = match events_2[0] {
3680                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3681                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3682                         msg.clone()
3683                 },
3684                 _ => panic!("Unexpected event"),
3685         };
3686         let bs_announcement_sigs = match events_2[1] {
3687                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3688                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3689                         msg.clone()
3690                 },
3691                 _ => panic!("Unexpected event"),
3692         };
3693
3694         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3695
3696         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3697         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3698         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3699         assert_eq!(events_3.len(), 2);
3700         let as_announcement_sigs = match events_3[0] {
3701                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3702                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3703                         msg.clone()
3704                 },
3705                 _ => panic!("Unexpected event"),
3706         };
3707         let (as_announcement, as_update) = match events_3[1] {
3708                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3709                         (msg.clone(), update_msg.clone())
3710                 },
3711                 _ => panic!("Unexpected event"),
3712         };
3713
3714         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3715         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3716         assert_eq!(events_4.len(), 1);
3717         let (_, bs_update) = match events_4[0] {
3718                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3719                         (msg.clone(), update_msg.clone())
3720                 },
3721                 _ => panic!("Unexpected event"),
3722         };
3723
3724         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3725         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3726         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3727
3728         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3729         let logger = test_utils::TestLogger::new();
3730         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();
3731         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3732         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3733
3734         // Check that after deserialization and reconnection we can still generate an identical
3735         // channel_announcement from the cached signatures.
3736         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3737
3738         let nodes_0_serialized = nodes[0].node.encode();
3739         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3740         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
3741
3742         persister = test_utils::TestPersister::new();
3743         let keys_manager = &chanmon_cfgs[0].keys_manager;
3744         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);
3745         nodes[0].chain_monitor = &new_chain_monitor;
3746         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3747         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
3748                 &mut chan_0_monitor_read, keys_manager).unwrap();
3749         assert!(chan_0_monitor_read.is_empty());
3750
3751         let mut nodes_0_read = &nodes_0_serialized[..];
3752         let (_, nodes_0_deserialized_tmp) = {
3753                 let mut channel_monitors = HashMap::new();
3754                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
3755                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3756                         default_config: UserConfig::default(),
3757                         keys_manager,
3758                         fee_estimator: node_cfgs[0].fee_estimator,
3759                         chain_monitor: nodes[0].chain_monitor,
3760                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3761                         logger: nodes[0].logger,
3762                         channel_monitors,
3763                 }).unwrap()
3764         };
3765         nodes_0_deserialized = nodes_0_deserialized_tmp;
3766         assert!(nodes_0_read.is_empty());
3767
3768         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
3769         nodes[0].node = &nodes_0_deserialized;
3770         check_added_monitors!(nodes[0], 1);
3771
3772         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3773
3774         // as_announcement should be re-generated exactly by broadcast_node_announcement.
3775         nodes[0].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
3776         let msgs = nodes[0].node.get_and_clear_pending_msg_events();
3777         let mut found_announcement = false;
3778         for event in msgs.iter() {
3779                 match event {
3780                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
3781                                 if *msg == as_announcement { found_announcement = true; }
3782                         },
3783                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
3784                         _ => panic!("Unexpected event"),
3785                 }
3786         }
3787         assert!(found_announcement);
3788 }
3789
3790 #[test]
3791 fn test_drop_messages_peer_disconnect_dual_htlc() {
3792         // Test that we can handle reconnecting when both sides of a channel have pending
3793         // commitment_updates when we disconnect.
3794         let chanmon_cfgs = create_chanmon_cfgs(2);
3795         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3796         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3797         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3798         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3799         let logger = test_utils::TestLogger::new();
3800
3801         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3802
3803         // Now try to send a second payment which will fail to send
3804         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3805         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3806         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();
3807         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3808         check_added_monitors!(nodes[0], 1);
3809
3810         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3811         assert_eq!(events_1.len(), 1);
3812         match events_1[0] {
3813                 MessageSendEvent::UpdateHTLCs { .. } => {},
3814                 _ => panic!("Unexpected event"),
3815         }
3816
3817         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3818         check_added_monitors!(nodes[1], 1);
3819
3820         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3821         assert_eq!(events_2.len(), 1);
3822         match events_2[0] {
3823                 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 } } => {
3824                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3825                         assert!(update_add_htlcs.is_empty());
3826                         assert_eq!(update_fulfill_htlcs.len(), 1);
3827                         assert!(update_fail_htlcs.is_empty());
3828                         assert!(update_fail_malformed_htlcs.is_empty());
3829                         assert!(update_fee.is_none());
3830
3831                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3832                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3833                         assert_eq!(events_3.len(), 1);
3834                         match events_3[0] {
3835                                 Event::PaymentSent { ref payment_preimage } => {
3836                                         assert_eq!(*payment_preimage, payment_preimage_1);
3837                                 },
3838                                 _ => panic!("Unexpected event"),
3839                         }
3840
3841                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3842                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3843                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3844                         check_added_monitors!(nodes[0], 1);
3845                 },
3846                 _ => panic!("Unexpected event"),
3847         }
3848
3849         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3850         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3851
3852         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3853         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3854         assert_eq!(reestablish_1.len(), 1);
3855         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3856         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3857         assert_eq!(reestablish_2.len(), 1);
3858
3859         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3860         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3861         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3862         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3863
3864         assert!(as_resp.0.is_none());
3865         assert!(bs_resp.0.is_none());
3866
3867         assert!(bs_resp.1.is_none());
3868         assert!(bs_resp.2.is_none());
3869
3870         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3871
3872         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3873         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3874         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3875         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3876         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3877         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3878         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3879         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3880         // No commitment_signed so get_event_msg's assert(len == 1) passes
3881         check_added_monitors!(nodes[1], 1);
3882
3883         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3884         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3885         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3886         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3887         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3888         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3889         assert!(bs_second_commitment_signed.update_fee.is_none());
3890         check_added_monitors!(nodes[1], 1);
3891
3892         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3893         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3894         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3895         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3896         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3897         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3898         assert!(as_commitment_signed.update_fee.is_none());
3899         check_added_monitors!(nodes[0], 1);
3900
3901         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3902         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3903         // No commitment_signed so get_event_msg's assert(len == 1) passes
3904         check_added_monitors!(nodes[0], 1);
3905
3906         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3907         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3908         // No commitment_signed so get_event_msg's assert(len == 1) passes
3909         check_added_monitors!(nodes[1], 1);
3910
3911         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3912         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3913         check_added_monitors!(nodes[1], 1);
3914
3915         expect_pending_htlcs_forwardable!(nodes[1]);
3916
3917         let events_5 = nodes[1].node.get_and_clear_pending_events();
3918         assert_eq!(events_5.len(), 1);
3919         match events_5[0] {
3920                 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
3921                         assert_eq!(payment_hash_2, *payment_hash);
3922                         match &purpose {
3923                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3924                                         assert!(payment_preimage.is_none());
3925                                         assert_eq!(payment_secret_2, *payment_secret);
3926                                 },
3927                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3928                         }
3929                 },
3930                 _ => panic!("Unexpected event"),
3931         }
3932
3933         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3934         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3935         check_added_monitors!(nodes[0], 1);
3936
3937         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3938 }
3939
3940 fn do_test_htlc_timeout(send_partial_mpp: bool) {
3941         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
3942         // to avoid our counterparty failing the channel.
3943         let chanmon_cfgs = create_chanmon_cfgs(2);
3944         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3945         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3946         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3947
3948         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3949         let logger = test_utils::TestLogger::new();
3950
3951         let our_payment_hash = if send_partial_mpp {
3952                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3953                 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();
3954                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
3955                 // Use the utility function send_payment_along_path to send the payment with MPP data which
3956                 // indicates there are more HTLCs coming.
3957                 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.
3958                 let mpp_id = MppId([42; 32]);
3959                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height, mpp_id, &None).unwrap();
3960                 check_added_monitors!(nodes[0], 1);
3961                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3962                 assert_eq!(events.len(), 1);
3963                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
3964                 // hop should *not* yet generate any PaymentReceived event(s).
3965                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
3966                 our_payment_hash
3967         } else {
3968                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
3969         };
3970
3971         let mut block = Block {
3972                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3973                 txdata: vec![],
3974         };
3975         connect_block(&nodes[0], &block);
3976         connect_block(&nodes[1], &block);
3977         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
3978         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
3979                 block.header.prev_blockhash = block.block_hash();
3980                 connect_block(&nodes[0], &block);
3981                 connect_block(&nodes[1], &block);
3982         }
3983
3984         expect_pending_htlcs_forwardable!(nodes[1]);
3985
3986         check_added_monitors!(nodes[1], 1);
3987         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3988         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
3989         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
3990         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
3991         assert!(htlc_timeout_updates.update_fee.is_none());
3992
3993         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
3994         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
3995         // 100_000 msat as u64, followed by the height at which we failed back above
3996         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
3997         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
3998         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
3999 }
4000
4001 #[test]
4002 fn test_htlc_timeout() {
4003         do_test_htlc_timeout(true);
4004         do_test_htlc_timeout(false);
4005 }
4006
4007 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4008         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4009         let chanmon_cfgs = create_chanmon_cfgs(3);
4010         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4011         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4012         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4013         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4014         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4015
4016         // Make sure all nodes are at the same starting height
4017         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4018         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4019         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4020
4021         let logger = test_utils::TestLogger::new();
4022
4023         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4024         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4025         {
4026                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4027                 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();
4028                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4029         }
4030         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4031         check_added_monitors!(nodes[1], 1);
4032
4033         // Now attempt to route a second payment, which should be placed in the holding cell
4034         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4035         if forwarded_htlc {
4036                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4037                 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();
4038                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4039                 check_added_monitors!(nodes[0], 1);
4040                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4041                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4042                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4043                 expect_pending_htlcs_forwardable!(nodes[1]);
4044                 check_added_monitors!(nodes[1], 0);
4045         } else {
4046                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4047                 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();
4048                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4049                 check_added_monitors!(nodes[1], 0);
4050         }
4051
4052         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4053         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4054         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4055         connect_blocks(&nodes[1], 1);
4056
4057         if forwarded_htlc {
4058                 expect_pending_htlcs_forwardable!(nodes[1]);
4059                 check_added_monitors!(nodes[1], 1);
4060                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4061                 assert_eq!(fail_commit.len(), 1);
4062                 match fail_commit[0] {
4063                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4064                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4065                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4066                         },
4067                         _ => unreachable!(),
4068                 }
4069                 expect_payment_failed_with_update!(nodes[0], second_payment_hash, false, chan_2.0.contents.short_channel_id, false);
4070         } else {
4071                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4072         }
4073 }
4074
4075 #[test]
4076 fn test_holding_cell_htlc_add_timeouts() {
4077         do_test_holding_cell_htlc_add_timeouts(false);
4078         do_test_holding_cell_htlc_add_timeouts(true);
4079 }
4080
4081 #[test]
4082 fn test_no_txn_manager_serialize_deserialize() {
4083         let chanmon_cfgs = create_chanmon_cfgs(2);
4084         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4085         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4086         let logger: test_utils::TestLogger;
4087         let fee_estimator: test_utils::TestFeeEstimator;
4088         let persister: test_utils::TestPersister;
4089         let new_chain_monitor: test_utils::TestChainMonitor;
4090         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4091         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4092
4093         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4094
4095         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4096
4097         let nodes_0_serialized = nodes[0].node.encode();
4098         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4099         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4100
4101         logger = test_utils::TestLogger::new();
4102         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4103         persister = test_utils::TestPersister::new();
4104         let keys_manager = &chanmon_cfgs[0].keys_manager;
4105         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4106         nodes[0].chain_monitor = &new_chain_monitor;
4107         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4108         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4109                 &mut chan_0_monitor_read, keys_manager).unwrap();
4110         assert!(chan_0_monitor_read.is_empty());
4111
4112         let mut nodes_0_read = &nodes_0_serialized[..];
4113         let config = UserConfig::default();
4114         let (_, nodes_0_deserialized_tmp) = {
4115                 let mut channel_monitors = HashMap::new();
4116                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4117                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4118                         default_config: config,
4119                         keys_manager,
4120                         fee_estimator: &fee_estimator,
4121                         chain_monitor: nodes[0].chain_monitor,
4122                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4123                         logger: &logger,
4124                         channel_monitors,
4125                 }).unwrap()
4126         };
4127         nodes_0_deserialized = nodes_0_deserialized_tmp;
4128         assert!(nodes_0_read.is_empty());
4129
4130         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4131         nodes[0].node = &nodes_0_deserialized;
4132         assert_eq!(nodes[0].node.list_channels().len(), 1);
4133         check_added_monitors!(nodes[0], 1);
4134
4135         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4136         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4137         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4138         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4139
4140         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4141         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4142         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4143         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4144
4145         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4146         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4147         for node in nodes.iter() {
4148                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4149                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4150                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4151         }
4152
4153         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4154 }
4155
4156 #[test]
4157 fn mpp_failure() {
4158         let chanmon_cfgs = create_chanmon_cfgs(4);
4159         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4160         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4161         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4162
4163         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4164         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4165         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4166         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
4167         let logger = test_utils::TestLogger::new();
4168
4169         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
4170         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4171         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();
4172         let path = route.paths[0].clone();
4173         route.paths.push(path);
4174         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
4175         route.paths[0][0].short_channel_id = chan_1_id;
4176         route.paths[0][1].short_channel_id = chan_3_id;
4177         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
4178         route.paths[1][0].short_channel_id = chan_2_id;
4179         route.paths[1][1].short_channel_id = chan_4_id;
4180         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
4181         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
4182 }
4183
4184 #[test]
4185 fn test_dup_htlc_onchain_fails_on_reload() {
4186         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4187         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4188         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4189         // the ChannelMonitor tells it to.
4190         //
4191         // If, due to an on-chain event, an HTLC is failed/claimed, and then we serialize the
4192         // ChannelManager, we generally expect there not to be a duplicate HTLC fail/claim (eg via a
4193         // PaymentFailed event appearing). However, because we may not serialize the relevant
4194         // ChannelMonitor at the same time, this isn't strictly guaranteed. In order to provide this
4195         // consistency, the ChannelManager explicitly tracks pending-onchain-resolution outbound HTLCs
4196         // and de-duplicates ChannelMonitor events.
4197         //
4198         // This tests that explicit tracking behavior.
4199         let chanmon_cfgs = create_chanmon_cfgs(2);
4200         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4201         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4202         let persister: test_utils::TestPersister;
4203         let new_chain_monitor: test_utils::TestChainMonitor;
4204         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4205         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4206
4207         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4208
4209         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4210         // nodes[0].
4211         let (payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4212         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4213         check_closed_broadcast!(nodes[0], true);
4214         check_added_monitors!(nodes[0], 1);
4215         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
4216
4217         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4218         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4219
4220         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4221         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4222         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4223         assert_eq!(node_txn.len(), 3);
4224         assert_eq!(node_txn[0], node_txn[1]);
4225
4226         assert!(nodes[1].node.claim_funds(payment_preimage));
4227         check_added_monitors!(nodes[1], 1);
4228
4229         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4230         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4231         check_closed_broadcast!(nodes[1], true);
4232         check_added_monitors!(nodes[1], 1);
4233         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
4234         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4235
4236         header.prev_blockhash = nodes[0].best_block_hash();
4237         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone(), node_txn[2].clone()]});
4238
4239         // Serialize out the ChannelMonitor before connecting the on-chain claim transactions. This is
4240         // fairly normal behavior as ChannelMonitor(s) are often not re-serialized when on-chain events
4241         // happen, unlike ChannelManager which tends to be re-serialized after any relevant event(s).
4242         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4243         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4244
4245         header.prev_blockhash = nodes[0].best_block_hash();
4246         let claim_block = Block { header, txdata: claim_txn};
4247         connect_block(&nodes[0], &claim_block);
4248         expect_payment_sent!(nodes[0], payment_preimage);
4249
4250         // ChannelManagers generally get re-serialized after any relevant event(s). Since we just
4251         // connected a highly-relevant block, it likely gets serialized out now.
4252         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4253         nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4254
4255         // Now reload nodes[0]...
4256         persister = test_utils::TestPersister::new();
4257         let keys_manager = &chanmon_cfgs[0].keys_manager;
4258         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);
4259         nodes[0].chain_monitor = &new_chain_monitor;
4260         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4261         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4262                 &mut chan_0_monitor_read, keys_manager).unwrap();
4263         assert!(chan_0_monitor_read.is_empty());
4264
4265         let (_, nodes_0_deserialized_tmp) = {
4266                 let mut channel_monitors = HashMap::new();
4267                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4268                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4269                         ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4270                                 default_config: Default::default(),
4271                                 keys_manager,
4272                                 fee_estimator: node_cfgs[0].fee_estimator,
4273                                 chain_monitor: nodes[0].chain_monitor,
4274                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4275                                 logger: nodes[0].logger,
4276                                 channel_monitors,
4277                         }).unwrap()
4278         };
4279         nodes_0_deserialized = nodes_0_deserialized_tmp;
4280
4281         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4282         check_added_monitors!(nodes[0], 1);
4283         nodes[0].node = &nodes_0_deserialized;
4284
4285         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4286         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4287         // payment events should kick in, leaving us with no pending events here.
4288         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4289         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4290         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4291 }
4292
4293 #[test]
4294 fn test_manager_serialize_deserialize_events() {
4295         // This test makes sure the events field in ChannelManager survives de/serialization
4296         let chanmon_cfgs = create_chanmon_cfgs(2);
4297         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4298         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4299         let fee_estimator: test_utils::TestFeeEstimator;
4300         let persister: test_utils::TestPersister;
4301         let logger: test_utils::TestLogger;
4302         let new_chain_monitor: test_utils::TestChainMonitor;
4303         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4304         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4305
4306         // Start creating a channel, but stop right before broadcasting the funding transaction
4307         let channel_value = 100000;
4308         let push_msat = 10001;
4309         let a_flags = InitFeatures::known();
4310         let b_flags = InitFeatures::known();
4311         let node_a = nodes.remove(0);
4312         let node_b = nodes.remove(0);
4313         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4314         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()));
4315         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()));
4316
4317         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4318
4319         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4320         check_added_monitors!(node_a, 0);
4321
4322         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()));
4323         {
4324                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4325                 assert_eq!(added_monitors.len(), 1);
4326                 assert_eq!(added_monitors[0].0, funding_output);
4327                 added_monitors.clear();
4328         }
4329
4330         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()));
4331         {
4332                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4333                 assert_eq!(added_monitors.len(), 1);
4334                 assert_eq!(added_monitors[0].0, funding_output);
4335                 added_monitors.clear();
4336         }
4337         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4338
4339         nodes.push(node_a);
4340         nodes.push(node_b);
4341
4342         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4343         let nodes_0_serialized = nodes[0].node.encode();
4344         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4345         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4346
4347         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4348         logger = test_utils::TestLogger::new();
4349         persister = test_utils::TestPersister::new();
4350         let keys_manager = &chanmon_cfgs[0].keys_manager;
4351         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4352         nodes[0].chain_monitor = &new_chain_monitor;
4353         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4354         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4355                 &mut chan_0_monitor_read, keys_manager).unwrap();
4356         assert!(chan_0_monitor_read.is_empty());
4357
4358         let mut nodes_0_read = &nodes_0_serialized[..];
4359         let config = UserConfig::default();
4360         let (_, nodes_0_deserialized_tmp) = {
4361                 let mut channel_monitors = HashMap::new();
4362                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4363                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4364                         default_config: config,
4365                         keys_manager,
4366                         fee_estimator: &fee_estimator,
4367                         chain_monitor: nodes[0].chain_monitor,
4368                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4369                         logger: &logger,
4370                         channel_monitors,
4371                 }).unwrap()
4372         };
4373         nodes_0_deserialized = nodes_0_deserialized_tmp;
4374         assert!(nodes_0_read.is_empty());
4375
4376         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4377
4378         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4379         nodes[0].node = &nodes_0_deserialized;
4380
4381         // After deserializing, make sure the funding_transaction is still held by the channel manager
4382         let events_4 = nodes[0].node.get_and_clear_pending_events();
4383         assert_eq!(events_4.len(), 0);
4384         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4385         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4386
4387         // Make sure the channel is functioning as though the de/serialization never happened
4388         assert_eq!(nodes[0].node.list_channels().len(), 1);
4389         check_added_monitors!(nodes[0], 1);
4390
4391         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4392         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4393         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4394         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4395
4396         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4397         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4398         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4399         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4400
4401         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4402         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4403         for node in nodes.iter() {
4404                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4405                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4406                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4407         }
4408
4409         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4410 }
4411
4412 #[test]
4413 fn test_simple_manager_serialize_deserialize() {
4414         let chanmon_cfgs = create_chanmon_cfgs(2);
4415         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4416         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4417         let logger: test_utils::TestLogger;
4418         let fee_estimator: test_utils::TestFeeEstimator;
4419         let persister: test_utils::TestPersister;
4420         let new_chain_monitor: test_utils::TestChainMonitor;
4421         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4422         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4423         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4424
4425         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4426         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4427
4428         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4429
4430         let nodes_0_serialized = nodes[0].node.encode();
4431         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4432         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4433
4434         logger = test_utils::TestLogger::new();
4435         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4436         persister = test_utils::TestPersister::new();
4437         let keys_manager = &chanmon_cfgs[0].keys_manager;
4438         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4439         nodes[0].chain_monitor = &new_chain_monitor;
4440         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4441         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4442                 &mut chan_0_monitor_read, keys_manager).unwrap();
4443         assert!(chan_0_monitor_read.is_empty());
4444
4445         let mut nodes_0_read = &nodes_0_serialized[..];
4446         let (_, nodes_0_deserialized_tmp) = {
4447                 let mut channel_monitors = HashMap::new();
4448                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4449                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4450                         default_config: UserConfig::default(),
4451                         keys_manager,
4452                         fee_estimator: &fee_estimator,
4453                         chain_monitor: nodes[0].chain_monitor,
4454                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4455                         logger: &logger,
4456                         channel_monitors,
4457                 }).unwrap()
4458         };
4459         nodes_0_deserialized = nodes_0_deserialized_tmp;
4460         assert!(nodes_0_read.is_empty());
4461
4462         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4463         nodes[0].node = &nodes_0_deserialized;
4464         check_added_monitors!(nodes[0], 1);
4465
4466         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4467
4468         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4469         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4470 }
4471
4472 #[test]
4473 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4474         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4475         let chanmon_cfgs = create_chanmon_cfgs(4);
4476         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4477         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4478         let logger: test_utils::TestLogger;
4479         let fee_estimator: test_utils::TestFeeEstimator;
4480         let persister: test_utils::TestPersister;
4481         let new_chain_monitor: test_utils::TestChainMonitor;
4482         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4483         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4484         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4485         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4486         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4487
4488         let mut node_0_stale_monitors_serialized = Vec::new();
4489         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4490                 let mut writer = test_utils::TestVecWriter(Vec::new());
4491                 monitor.1.write(&mut writer).unwrap();
4492                 node_0_stale_monitors_serialized.push(writer.0);
4493         }
4494
4495         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4496
4497         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4498         let nodes_0_serialized = nodes[0].node.encode();
4499
4500         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4501         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4502         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4503         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4504
4505         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4506         // nodes[3])
4507         let mut node_0_monitors_serialized = Vec::new();
4508         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4509                 let mut writer = test_utils::TestVecWriter(Vec::new());
4510                 monitor.1.write(&mut writer).unwrap();
4511                 node_0_monitors_serialized.push(writer.0);
4512         }
4513
4514         logger = test_utils::TestLogger::new();
4515         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
4516         persister = test_utils::TestPersister::new();
4517         let keys_manager = &chanmon_cfgs[0].keys_manager;
4518         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4519         nodes[0].chain_monitor = &new_chain_monitor;
4520
4521
4522         let mut node_0_stale_monitors = Vec::new();
4523         for serialized in node_0_stale_monitors_serialized.iter() {
4524                 let mut read = &serialized[..];
4525                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4526                 assert!(read.is_empty());
4527                 node_0_stale_monitors.push(monitor);
4528         }
4529
4530         let mut node_0_monitors = Vec::new();
4531         for serialized in node_0_monitors_serialized.iter() {
4532                 let mut read = &serialized[..];
4533                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4534                 assert!(read.is_empty());
4535                 node_0_monitors.push(monitor);
4536         }
4537
4538         let mut nodes_0_read = &nodes_0_serialized[..];
4539         if let Err(msgs::DecodeError::InvalidValue) =
4540                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4541                 default_config: UserConfig::default(),
4542                 keys_manager,
4543                 fee_estimator: &fee_estimator,
4544                 chain_monitor: nodes[0].chain_monitor,
4545                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4546                 logger: &logger,
4547                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4548         }) { } else {
4549                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4550         };
4551
4552         let mut nodes_0_read = &nodes_0_serialized[..];
4553         let (_, nodes_0_deserialized_tmp) =
4554                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4555                 default_config: UserConfig::default(),
4556                 keys_manager,
4557                 fee_estimator: &fee_estimator,
4558                 chain_monitor: nodes[0].chain_monitor,
4559                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4560                 logger: &logger,
4561                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4562         }).unwrap();
4563         nodes_0_deserialized = nodes_0_deserialized_tmp;
4564         assert!(nodes_0_read.is_empty());
4565
4566         { // Channel close should result in a commitment tx
4567                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4568                 assert_eq!(txn.len(), 1);
4569                 check_spends!(txn[0], funding_tx);
4570                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4571         }
4572
4573         for monitor in node_0_monitors.drain(..) {
4574                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4575                 check_added_monitors!(nodes[0], 1);
4576         }
4577         nodes[0].node = &nodes_0_deserialized;
4578
4579         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4580         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4581         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4582         //... and we can even still claim the payment!
4583         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4584
4585         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4586         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4587         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4588         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4589         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4590         assert_eq!(msg_events.len(), 1);
4591         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4592                 match action {
4593                         &ErrorAction::SendErrorMessage { ref msg } => {
4594                                 assert_eq!(msg.channel_id, channel_id);
4595                         },
4596                         _ => panic!("Unexpected event!"),
4597                 }
4598         }
4599 }
4600
4601 macro_rules! check_spendable_outputs {
4602         ($node: expr, $keysinterface: expr) => {
4603                 {
4604                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4605                         let mut txn = Vec::new();
4606                         let mut all_outputs = Vec::new();
4607                         let secp_ctx = Secp256k1::new();
4608                         for event in events.drain(..) {
4609                                 match event {
4610                                         Event::SpendableOutputs { mut outputs } => {
4611                                                 for outp in outputs.drain(..) {
4612                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4613                                                         all_outputs.push(outp);
4614                                                 }
4615                                         },
4616                                         _ => panic!("Unexpected event"),
4617                                 };
4618                         }
4619                         if all_outputs.len() > 1 {
4620                                 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) {
4621                                         txn.push(tx);
4622                                 }
4623                         }
4624                         txn
4625                 }
4626         }
4627 }
4628
4629 #[test]
4630 fn test_claim_sizeable_push_msat() {
4631         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4632         let chanmon_cfgs = create_chanmon_cfgs(2);
4633         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4634         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4635         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4636
4637         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4638         nodes[1].node.force_close_channel(&chan.2).unwrap();
4639         check_closed_broadcast!(nodes[1], true);
4640         check_added_monitors!(nodes[1], 1);
4641         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
4642         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4643         assert_eq!(node_txn.len(), 1);
4644         check_spends!(node_txn[0], chan.3);
4645         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
4646
4647         mine_transaction(&nodes[1], &node_txn[0]);
4648         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4649
4650         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4651         assert_eq!(spend_txn.len(), 1);
4652         assert_eq!(spend_txn[0].input.len(), 1);
4653         check_spends!(spend_txn[0], node_txn[0]);
4654         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
4655 }
4656
4657 #[test]
4658 fn test_claim_on_remote_sizeable_push_msat() {
4659         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4660         // to_remote output is encumbered by a P2WPKH
4661         let chanmon_cfgs = create_chanmon_cfgs(2);
4662         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4663         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4664         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4665
4666         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4667         nodes[0].node.force_close_channel(&chan.2).unwrap();
4668         check_closed_broadcast!(nodes[0], true);
4669         check_added_monitors!(nodes[0], 1);
4670         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
4671
4672         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4673         assert_eq!(node_txn.len(), 1);
4674         check_spends!(node_txn[0], chan.3);
4675         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
4676
4677         mine_transaction(&nodes[1], &node_txn[0]);
4678         check_closed_broadcast!(nodes[1], true);
4679         check_added_monitors!(nodes[1], 1);
4680         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
4681         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4682
4683         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4684         assert_eq!(spend_txn.len(), 1);
4685         check_spends!(spend_txn[0], node_txn[0]);
4686 }
4687
4688 #[test]
4689 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4690         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4691         // to_remote output is encumbered by a P2WPKH
4692
4693         let chanmon_cfgs = create_chanmon_cfgs(2);
4694         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4695         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4696         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4697
4698         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4699         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4700         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4701         assert_eq!(revoked_local_txn[0].input.len(), 1);
4702         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4703
4704         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4705         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4706         check_closed_broadcast!(nodes[1], true);
4707         check_added_monitors!(nodes[1], 1);
4708         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
4709
4710         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4711         mine_transaction(&nodes[1], &node_txn[0]);
4712         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4713
4714         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4715         assert_eq!(spend_txn.len(), 3);
4716         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4717         check_spends!(spend_txn[1], node_txn[0]);
4718         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4719 }
4720
4721 #[test]
4722 fn test_static_spendable_outputs_preimage_tx() {
4723         let chanmon_cfgs = create_chanmon_cfgs(2);
4724         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4725         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4726         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4727
4728         // Create some initial channels
4729         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4730
4731         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4732
4733         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4734         assert_eq!(commitment_tx[0].input.len(), 1);
4735         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4736
4737         // Settle A's commitment tx on B's chain
4738         assert!(nodes[1].node.claim_funds(payment_preimage));
4739         check_added_monitors!(nodes[1], 1);
4740         mine_transaction(&nodes[1], &commitment_tx[0]);
4741         check_added_monitors!(nodes[1], 1);
4742         let events = nodes[1].node.get_and_clear_pending_msg_events();
4743         match events[0] {
4744                 MessageSendEvent::UpdateHTLCs { .. } => {},
4745                 _ => panic!("Unexpected event"),
4746         }
4747         match events[1] {
4748                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4749                 _ => panic!("Unexepected event"),
4750         }
4751
4752         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4753         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4754         assert_eq!(node_txn.len(), 3);
4755         check_spends!(node_txn[0], commitment_tx[0]);
4756         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4757         check_spends!(node_txn[1], chan_1.3);
4758         check_spends!(node_txn[2], node_txn[1]);
4759
4760         mine_transaction(&nodes[1], &node_txn[0]);
4761         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
4762         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4763
4764         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4765         assert_eq!(spend_txn.len(), 1);
4766         check_spends!(spend_txn[0], node_txn[0]);
4767 }
4768
4769 #[test]
4770 fn test_static_spendable_outputs_timeout_tx() {
4771         let chanmon_cfgs = create_chanmon_cfgs(2);
4772         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4773         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4774         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4775
4776         // Create some initial channels
4777         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4778
4779         // Rebalance the network a bit by relaying one payment through all the channels ...
4780         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4781
4782         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4783
4784         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4785         assert_eq!(commitment_tx[0].input.len(), 1);
4786         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4787
4788         // Settle A's commitment tx on B' chain
4789         mine_transaction(&nodes[1], &commitment_tx[0]);
4790         check_added_monitors!(nodes[1], 1);
4791         let events = nodes[1].node.get_and_clear_pending_msg_events();
4792         match events[0] {
4793                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4794                 _ => panic!("Unexpected event"),
4795         }
4796         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4797
4798         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4799         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4800         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
4801         check_spends!(node_txn[0], chan_1.3.clone());
4802         check_spends!(node_txn[1],  commitment_tx[0].clone());
4803         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4804
4805         mine_transaction(&nodes[1], &node_txn[1]);
4806         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
4807         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4808         expect_payment_failed!(nodes[1], our_payment_hash, true);
4809
4810         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4811         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4812         check_spends!(spend_txn[0], commitment_tx[0]);
4813         check_spends!(spend_txn[1], node_txn[1]);
4814         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
4815 }
4816
4817 #[test]
4818 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4819         let chanmon_cfgs = create_chanmon_cfgs(2);
4820         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4821         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4822         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4823
4824         // Create some initial channels
4825         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4826
4827         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4828         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4829         assert_eq!(revoked_local_txn[0].input.len(), 1);
4830         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4831
4832         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4833
4834         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4835         check_closed_broadcast!(nodes[1], true);
4836         check_added_monitors!(nodes[1], 1);
4837         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
4838
4839         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4840         assert_eq!(node_txn.len(), 2);
4841         assert_eq!(node_txn[0].input.len(), 2);
4842         check_spends!(node_txn[0], revoked_local_txn[0]);
4843
4844         mine_transaction(&nodes[1], &node_txn[0]);
4845         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4846
4847         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4848         assert_eq!(spend_txn.len(), 1);
4849         check_spends!(spend_txn[0], node_txn[0]);
4850 }
4851
4852 #[test]
4853 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4854         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4855         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4856         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4857         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4858         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4859
4860         // Create some initial channels
4861         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4862
4863         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4864         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4865         assert_eq!(revoked_local_txn[0].input.len(), 1);
4866         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4867
4868         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4869
4870         // A will generate HTLC-Timeout from revoked commitment tx
4871         mine_transaction(&nodes[0], &revoked_local_txn[0]);
4872         check_closed_broadcast!(nodes[0], true);
4873         check_added_monitors!(nodes[0], 1);
4874         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxBroadcasted);
4875         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4876
4877         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4878         assert_eq!(revoked_htlc_txn.len(), 2);
4879         check_spends!(revoked_htlc_txn[0], chan_1.3);
4880         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
4881         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4882         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
4883         assert_ne!(revoked_htlc_txn[1].lock_time, 0); // HTLC-Timeout
4884
4885         // B will generate justice tx from A's revoked commitment/HTLC tx
4886         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4887         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
4888         check_closed_broadcast!(nodes[1], true);
4889         check_added_monitors!(nodes[1], 1);
4890         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
4891
4892         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4893         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4894         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4895         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
4896         // transactions next...
4897         assert_eq!(node_txn[0].input.len(), 3);
4898         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
4899
4900         assert_eq!(node_txn[1].input.len(), 2);
4901         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
4902         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
4903                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4904         } else {
4905                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
4906                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4907         }
4908
4909         assert_eq!(node_txn[2].input.len(), 1);
4910         check_spends!(node_txn[2], chan_1.3);
4911
4912         mine_transaction(&nodes[1], &node_txn[1]);
4913         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4914
4915         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4916         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4917         assert_eq!(spend_txn.len(), 1);
4918         assert_eq!(spend_txn[0].input.len(), 1);
4919         check_spends!(spend_txn[0], node_txn[1]);
4920 }
4921
4922 #[test]
4923 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4924         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4925         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4926         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4927         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4928         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4929
4930         // Create some initial channels
4931         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4932
4933         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4934         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4935         assert_eq!(revoked_local_txn[0].input.len(), 1);
4936         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4937
4938         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4939         assert_eq!(revoked_local_txn[0].output.len(), 2);
4940
4941         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4942
4943         // B will generate HTLC-Success from revoked commitment tx
4944         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4945         check_closed_broadcast!(nodes[1], true);
4946         check_added_monitors!(nodes[1], 1);
4947         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
4948         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4949
4950         assert_eq!(revoked_htlc_txn.len(), 2);
4951         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4952         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4953         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4954
4955         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4956         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4957         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4958
4959         // A will generate justice tx from B's revoked commitment/HTLC tx
4960         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4961         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4962         check_closed_broadcast!(nodes[0], true);
4963         check_added_monitors!(nodes[0], 1);
4964         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxBroadcasted);
4965
4966         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4967         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4968
4969         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4970         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4971         // transactions next...
4972         assert_eq!(node_txn[0].input.len(), 2);
4973         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4974         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4975                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4976         } else {
4977                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4978                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4979         }
4980
4981         assert_eq!(node_txn[1].input.len(), 1);
4982         check_spends!(node_txn[1], revoked_htlc_txn[0]);
4983
4984         check_spends!(node_txn[2], chan_1.3);
4985
4986         mine_transaction(&nodes[0], &node_txn[1]);
4987         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
4988
4989         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4990         // didn't try to generate any new transactions.
4991
4992         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4993         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
4994         assert_eq!(spend_txn.len(), 3);
4995         assert_eq!(spend_txn[0].input.len(), 1);
4996         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4997         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4998         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
4999         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
5000 }
5001
5002 #[test]
5003 fn test_onchain_to_onchain_claim() {
5004         // Test that in case of channel closure, we detect the state of output and claim HTLC
5005         // on downstream peer's remote commitment tx.
5006         // First, have C claim an HTLC against its own latest commitment transaction.
5007         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5008         // channel.
5009         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5010         // gets broadcast.
5011
5012         let chanmon_cfgs = create_chanmon_cfgs(3);
5013         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5014         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5015         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5016
5017         // Create some initial channels
5018         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5019         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5020
5021         // Ensure all nodes are at the same height
5022         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5023         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5024         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5025         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5026
5027         // Rebalance the network a bit by relaying one payment through all the channels ...
5028         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5029         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5030
5031         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5032         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5033         check_spends!(commitment_tx[0], chan_2.3);
5034         nodes[2].node.claim_funds(payment_preimage);
5035         check_added_monitors!(nodes[2], 1);
5036         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5037         assert!(updates.update_add_htlcs.is_empty());
5038         assert!(updates.update_fail_htlcs.is_empty());
5039         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5040         assert!(updates.update_fail_malformed_htlcs.is_empty());
5041
5042         mine_transaction(&nodes[2], &commitment_tx[0]);
5043         check_closed_broadcast!(nodes[2], true);
5044         check_added_monitors!(nodes[2], 1);
5045         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxBroadcasted);
5046
5047         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5048         assert_eq!(c_txn.len(), 3);
5049         assert_eq!(c_txn[0], c_txn[2]);
5050         assert_eq!(commitment_tx[0], c_txn[1]);
5051         check_spends!(c_txn[1], chan_2.3);
5052         check_spends!(c_txn[2], c_txn[1]);
5053         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5054         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5055         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5056         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5057
5058         // 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
5059         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5060         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5061         check_added_monitors!(nodes[1], 1);
5062         let events = nodes[1].node.get_and_clear_pending_events();
5063         assert_eq!(events.len(), 2);
5064         match events[0] {
5065                 Event::ChannelClosed { .. } => {}
5066                 _ => panic!("Unexpected event"),
5067         }
5068         match events[1] {
5069                 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
5070                         assert_eq!(fee_earned_msat, Some(1000));
5071                         assert_eq!(claim_from_onchain_tx, true);
5072                 },
5073                 _ => panic!("Unexpected event"),
5074         }
5075         {
5076                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5077                 // ChannelMonitor: claim tx
5078                 assert_eq!(b_txn.len(), 1);
5079                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
5080                 b_txn.clear();
5081         }
5082         check_added_monitors!(nodes[1], 1);
5083         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5084         assert_eq!(msg_events.len(), 3);
5085         match msg_events[0] {
5086                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5087                 _ => panic!("Unexpected event"),
5088         }
5089         match msg_events[1] {
5090                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5091                 _ => panic!("Unexpected event"),
5092         }
5093         match msg_events[2] {
5094                 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, .. } } => {
5095                         assert!(update_add_htlcs.is_empty());
5096                         assert!(update_fail_htlcs.is_empty());
5097                         assert_eq!(update_fulfill_htlcs.len(), 1);
5098                         assert!(update_fail_malformed_htlcs.is_empty());
5099                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5100                 },
5101                 _ => panic!("Unexpected event"),
5102         };
5103         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5104         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5105         mine_transaction(&nodes[1], &commitment_tx[0]);
5106         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
5107         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5108         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5109         assert_eq!(b_txn.len(), 3);
5110         check_spends!(b_txn[1], chan_1.3);
5111         check_spends!(b_txn[2], b_txn[1]);
5112         check_spends!(b_txn[0], commitment_tx[0]);
5113         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5114         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5115         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5116
5117         check_closed_broadcast!(nodes[1], true);
5118         check_added_monitors!(nodes[1], 1);
5119 }
5120
5121 #[test]
5122 fn test_duplicate_payment_hash_one_failure_one_success() {
5123         // Topology : A --> B --> C --> D
5124         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5125         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5126         // we forward one of the payments onwards to D.
5127         let chanmon_cfgs = create_chanmon_cfgs(4);
5128         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5129         // When this test was written, the default base fee floated based on the HTLC count.
5130         // It is now fixed, so we simply set the fee to the expected value here.
5131         let mut config = test_default_channel_config();
5132         config.channel_options.forwarding_fee_base_msat = 196;
5133         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
5134                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5135         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5136
5137         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5138         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5139         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5140
5141         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5142         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5143         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5144         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5145         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
5146
5147         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5148
5149         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5150         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
5151         // script push size limit so that the below script length checks match
5152         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
5153         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
5154                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV - 40, nodes[0].logger).unwrap();
5155         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5156
5157         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5158         assert_eq!(commitment_txn[0].input.len(), 1);
5159         check_spends!(commitment_txn[0], chan_2.3);
5160
5161         mine_transaction(&nodes[1], &commitment_txn[0]);
5162         check_closed_broadcast!(nodes[1], true);
5163         check_added_monitors!(nodes[1], 1);
5164         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
5165         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
5166
5167         let htlc_timeout_tx;
5168         { // Extract one of the two HTLC-Timeout transaction
5169                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5170                 // ChannelMonitor: timeout tx * 3, ChannelManager: local commitment tx
5171                 assert_eq!(node_txn.len(), 4);
5172                 check_spends!(node_txn[0], chan_2.3);
5173
5174                 check_spends!(node_txn[1], commitment_txn[0]);
5175                 assert_eq!(node_txn[1].input.len(), 1);
5176                 check_spends!(node_txn[2], commitment_txn[0]);
5177                 assert_eq!(node_txn[2].input.len(), 1);
5178                 assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
5179                 check_spends!(node_txn[3], commitment_txn[0]);
5180                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
5181
5182                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5183                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5184                 assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5185                 htlc_timeout_tx = node_txn[1].clone();
5186         }
5187
5188         nodes[2].node.claim_funds(our_payment_preimage);
5189         mine_transaction(&nodes[2], &commitment_txn[0]);
5190         check_added_monitors!(nodes[2], 2);
5191         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxBroadcasted);
5192         let events = nodes[2].node.get_and_clear_pending_msg_events();
5193         match events[0] {
5194                 MessageSendEvent::UpdateHTLCs { .. } => {},
5195                 _ => panic!("Unexpected event"),
5196         }
5197         match events[1] {
5198                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5199                 _ => panic!("Unexepected event"),
5200         }
5201         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5202         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)
5203         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5204         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5205         assert_eq!(htlc_success_txn[0].input.len(), 1);
5206         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5207         assert_eq!(htlc_success_txn[1].input.len(), 1);
5208         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5209         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
5210         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
5211         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
5212         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
5213         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
5214
5215         mine_transaction(&nodes[1], &htlc_timeout_tx);
5216         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5217         expect_pending_htlcs_forwardable!(nodes[1]);
5218         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5219         assert!(htlc_updates.update_add_htlcs.is_empty());
5220         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5221         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
5222         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5223         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5224         check_added_monitors!(nodes[1], 1);
5225
5226         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5227         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5228         {
5229                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5230         }
5231         expect_payment_failed_with_update!(nodes[0], duplicate_payment_hash, false, chan_2.0.contents.short_channel_id, true);
5232
5233         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5234         // Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
5235         // and nodes[2] fee) is rounded down and then claimed in full.
5236         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5237         expect_payment_forwarded!(nodes[1], Some(196*2), true);
5238         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5239         assert!(updates.update_add_htlcs.is_empty());
5240         assert!(updates.update_fail_htlcs.is_empty());
5241         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5242         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
5243         assert!(updates.update_fail_malformed_htlcs.is_empty());
5244         check_added_monitors!(nodes[1], 1);
5245
5246         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5247         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5248
5249         let events = nodes[0].node.get_and_clear_pending_events();
5250         match events[0] {
5251                 Event::PaymentSent { ref payment_preimage } => {
5252                         assert_eq!(*payment_preimage, our_payment_preimage);
5253                 }
5254                 _ => panic!("Unexpected event"),
5255         }
5256 }
5257
5258 #[test]
5259 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5260         let chanmon_cfgs = create_chanmon_cfgs(2);
5261         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5262         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5263         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5264
5265         // Create some initial channels
5266         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5267
5268         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5269         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5270         assert_eq!(local_txn.len(), 1);
5271         assert_eq!(local_txn[0].input.len(), 1);
5272         check_spends!(local_txn[0], chan_1.3);
5273
5274         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5275         nodes[1].node.claim_funds(payment_preimage);
5276         check_added_monitors!(nodes[1], 1);
5277         mine_transaction(&nodes[1], &local_txn[0]);
5278         check_added_monitors!(nodes[1], 1);
5279         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
5280         let events = nodes[1].node.get_and_clear_pending_msg_events();
5281         match events[0] {
5282                 MessageSendEvent::UpdateHTLCs { .. } => {},
5283                 _ => panic!("Unexpected event"),
5284         }
5285         match events[1] {
5286                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5287                 _ => panic!("Unexepected event"),
5288         }
5289         let node_tx = {
5290                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5291                 assert_eq!(node_txn.len(), 3);
5292                 assert_eq!(node_txn[0], node_txn[2]);
5293                 assert_eq!(node_txn[1], local_txn[0]);
5294                 assert_eq!(node_txn[0].input.len(), 1);
5295                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5296                 check_spends!(node_txn[0], local_txn[0]);
5297                 node_txn[0].clone()
5298         };
5299
5300         mine_transaction(&nodes[1], &node_tx);
5301         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
5302
5303         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5304         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5305         assert_eq!(spend_txn.len(), 1);
5306         assert_eq!(spend_txn[0].input.len(), 1);
5307         check_spends!(spend_txn[0], node_tx);
5308         assert_eq!(spend_txn[0].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5309 }
5310
5311 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5312         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5313         // unrevoked commitment transaction.
5314         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5315         // a remote RAA before they could be failed backwards (and combinations thereof).
5316         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5317         // use the same payment hashes.
5318         // Thus, we use a six-node network:
5319         //
5320         // A \         / E
5321         //    - C - D -
5322         // B /         \ F
5323         // And test where C fails back to A/B when D announces its latest commitment transaction
5324         let chanmon_cfgs = create_chanmon_cfgs(6);
5325         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5326         // When this test was written, the default base fee floated based on the HTLC count.
5327         // It is now fixed, so we simply set the fee to the expected value here.
5328         let mut config = test_default_channel_config();
5329         config.channel_options.forwarding_fee_base_msat = 196;
5330         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
5331                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5332         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5333         let logger = test_utils::TestLogger::new();
5334
5335         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5336         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5337         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5338         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5339         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5340
5341         // Rebalance and check output sanity...
5342         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5343         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5344         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5345
5346         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5347         // 0th HTLC:
5348         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], ds_dust_limit*1000); // not added < dust limit + HTLC tx fee
5349         // 1st HTLC:
5350         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
5351         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5352         let our_node_id = &nodes[1].node.get_our_node_id();
5353         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();
5354         // 2nd HTLC:
5355         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
5356         // 3rd HTLC:
5357         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
5358         // 4th HTLC:
5359         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5360         // 5th HTLC:
5361         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5362         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();
5363         // 6th HTLC:
5364         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());
5365         // 7th HTLC:
5366         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());
5367
5368         // 8th HTLC:
5369         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5370         // 9th HTLC:
5371         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();
5372         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
5373
5374         // 10th HTLC:
5375         let (_, payment_hash_6, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], ds_dust_limit*1000); // not added < dust limit + HTLC tx fee
5376         // 11th HTLC:
5377         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();
5378         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());
5379
5380         // Double-check that six of the new HTLC were added
5381         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5382         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5383         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5384         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5385
5386         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5387         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5388         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5389         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5390         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5391         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5392         check_added_monitors!(nodes[4], 0);
5393         expect_pending_htlcs_forwardable!(nodes[4]);
5394         check_added_monitors!(nodes[4], 1);
5395
5396         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5397         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5398         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5399         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5400         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5401         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5402
5403         // Fail 3rd below-dust and 7th above-dust HTLCs
5404         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5405         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5406         check_added_monitors!(nodes[5], 0);
5407         expect_pending_htlcs_forwardable!(nodes[5]);
5408         check_added_monitors!(nodes[5], 1);
5409
5410         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5411         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5412         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5413         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5414
5415         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5416
5417         expect_pending_htlcs_forwardable!(nodes[3]);
5418         check_added_monitors!(nodes[3], 1);
5419         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5420         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5421         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5422         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5423         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5424         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5425         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5426         if deliver_last_raa {
5427                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5428         } else {
5429                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5430         }
5431
5432         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5433         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5434         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5435         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5436         //
5437         // We now broadcast the latest commitment transaction, which *should* result in failures for
5438         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5439         // the non-broadcast above-dust HTLCs.
5440         //
5441         // Alternatively, we may broadcast the previous commitment transaction, which should only
5442         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5443         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5444
5445         if announce_latest {
5446                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5447         } else {
5448                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5449         }
5450         let events = nodes[2].node.get_and_clear_pending_events();
5451         let close_event = if deliver_last_raa {
5452                 assert_eq!(events.len(), 2);
5453                 events[1].clone()
5454         } else {
5455                 assert_eq!(events.len(), 1);
5456                 events[0].clone()
5457         };
5458         match close_event {
5459                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxBroadcasted, .. } => {}
5460                 _ => panic!("Unexpected event"),
5461         }
5462
5463         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5464         check_closed_broadcast!(nodes[2], true);
5465         if deliver_last_raa {
5466                 expect_pending_htlcs_forwardable_from_events!(nodes[2], events[0..1], true);
5467         } else {
5468                 expect_pending_htlcs_forwardable!(nodes[2]);
5469         }
5470         check_added_monitors!(nodes[2], 3);
5471
5472         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5473         assert_eq!(cs_msgs.len(), 2);
5474         let mut a_done = false;
5475         for msg in cs_msgs {
5476                 match msg {
5477                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5478                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5479                                 // should be failed-backwards here.
5480                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5481                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5482                                         for htlc in &updates.update_fail_htlcs {
5483                                                 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 });
5484                                         }
5485                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5486                                         assert!(!a_done);
5487                                         a_done = true;
5488                                         &nodes[0]
5489                                 } else {
5490                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5491                                         for htlc in &updates.update_fail_htlcs {
5492                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5493                                         }
5494                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5495                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5496                                         &nodes[1]
5497                                 };
5498                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5499                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5500                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5501                                 if announce_latest {
5502                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5503                                         if *node_id == nodes[0].node.get_our_node_id() {
5504                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5505                                         }
5506                                 }
5507                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5508                         },
5509                         _ => panic!("Unexpected event"),
5510                 }
5511         }
5512
5513         let as_events = nodes[0].node.get_and_clear_pending_events();
5514         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5515         let mut as_failds = HashSet::new();
5516         let mut as_updates = 0;
5517         for event in as_events.iter() {
5518                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5519                         assert!(as_failds.insert(*payment_hash));
5520                         if *payment_hash != payment_hash_2 {
5521                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5522                         } else {
5523                                 assert!(!rejected_by_dest);
5524                         }
5525                         if network_update.is_some() {
5526                                 as_updates += 1;
5527                         }
5528                 } else { panic!("Unexpected event"); }
5529         }
5530         assert!(as_failds.contains(&payment_hash_1));
5531         assert!(as_failds.contains(&payment_hash_2));
5532         if announce_latest {
5533                 assert!(as_failds.contains(&payment_hash_3));
5534                 assert!(as_failds.contains(&payment_hash_5));
5535         }
5536         assert!(as_failds.contains(&payment_hash_6));
5537
5538         let bs_events = nodes[1].node.get_and_clear_pending_events();
5539         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5540         let mut bs_failds = HashSet::new();
5541         let mut bs_updates = 0;
5542         for event in bs_events.iter() {
5543                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, .. } = event {
5544                         assert!(bs_failds.insert(*payment_hash));
5545                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5546                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5547                         } else {
5548                                 assert!(!rejected_by_dest);
5549                         }
5550                         if network_update.is_some() {
5551                                 bs_updates += 1;
5552                         }
5553                 } else { panic!("Unexpected event"); }
5554         }
5555         assert!(bs_failds.contains(&payment_hash_1));
5556         assert!(bs_failds.contains(&payment_hash_2));
5557         if announce_latest {
5558                 assert!(bs_failds.contains(&payment_hash_4));
5559         }
5560         assert!(bs_failds.contains(&payment_hash_5));
5561
5562         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5563         // get a NetworkUpdate. A should have gotten 4 HTLCs which were failed-back due to
5564         // unknown-preimage-etc, B should have gotten 2. Thus, in the
5565         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2 NetworkUpdates.
5566         assert_eq!(as_updates, if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5567         assert_eq!(bs_updates, if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5568 }
5569
5570 #[test]
5571 fn test_fail_backwards_latest_remote_announce_a() {
5572         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5573 }
5574
5575 #[test]
5576 fn test_fail_backwards_latest_remote_announce_b() {
5577         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5578 }
5579
5580 #[test]
5581 fn test_fail_backwards_previous_remote_announce() {
5582         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5583         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5584         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5585 }
5586
5587 #[test]
5588 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5589         let chanmon_cfgs = create_chanmon_cfgs(2);
5590         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5591         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5592         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5593
5594         // Create some initial channels
5595         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5596
5597         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5598         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5599         assert_eq!(local_txn[0].input.len(), 1);
5600         check_spends!(local_txn[0], chan_1.3);
5601
5602         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5603         mine_transaction(&nodes[0], &local_txn[0]);
5604         check_closed_broadcast!(nodes[0], true);
5605         check_added_monitors!(nodes[0], 1);
5606         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxBroadcasted);
5607         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5608
5609         let htlc_timeout = {
5610                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5611                 assert_eq!(node_txn.len(), 2);
5612                 check_spends!(node_txn[0], chan_1.3);
5613                 assert_eq!(node_txn[1].input.len(), 1);
5614                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5615                 check_spends!(node_txn[1], local_txn[0]);
5616                 node_txn[1].clone()
5617         };
5618
5619         mine_transaction(&nodes[0], &htlc_timeout);
5620         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5621         expect_payment_failed!(nodes[0], our_payment_hash, true);
5622
5623         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5624         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5625         assert_eq!(spend_txn.len(), 3);
5626         check_spends!(spend_txn[0], local_txn[0]);
5627         assert_eq!(spend_txn[1].input.len(), 1);
5628         check_spends!(spend_txn[1], htlc_timeout);
5629         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5630         assert_eq!(spend_txn[2].input.len(), 2);
5631         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5632         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5633                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5634 }
5635
5636 #[test]
5637 fn test_key_derivation_params() {
5638         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5639         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5640         // let us re-derive the channel key set to then derive a delayed_payment_key.
5641
5642         let chanmon_cfgs = create_chanmon_cfgs(3);
5643
5644         // We manually create the node configuration to backup the seed.
5645         let seed = [42; 32];
5646         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5647         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);
5648         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() };
5649         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5650         node_cfgs.remove(0);
5651         node_cfgs.insert(0, node);
5652
5653         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5654         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5655
5656         // Create some initial channels
5657         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5658         // for node 0
5659         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5660         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5661         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5662
5663         // Ensure all nodes are at the same height
5664         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5665         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5666         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5667         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5668
5669         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5670         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5671         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5672         assert_eq!(local_txn_1[0].input.len(), 1);
5673         check_spends!(local_txn_1[0], chan_1.3);
5674
5675         // We check funding pubkey are unique
5676         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]));
5677         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]));
5678         if from_0_funding_key_0 == from_1_funding_key_0
5679             || from_0_funding_key_0 == from_1_funding_key_1
5680             || from_0_funding_key_1 == from_1_funding_key_0
5681             || from_0_funding_key_1 == from_1_funding_key_1 {
5682                 panic!("Funding pubkeys aren't unique");
5683         }
5684
5685         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5686         mine_transaction(&nodes[0], &local_txn_1[0]);
5687         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5688         check_closed_broadcast!(nodes[0], true);
5689         check_added_monitors!(nodes[0], 1);
5690         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxBroadcasted);
5691
5692         let htlc_timeout = {
5693                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5694                 assert_eq!(node_txn[1].input.len(), 1);
5695                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5696                 check_spends!(node_txn[1], local_txn_1[0]);
5697                 node_txn[1].clone()
5698         };
5699
5700         mine_transaction(&nodes[0], &htlc_timeout);
5701         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5702         expect_payment_failed!(nodes[0], our_payment_hash, true);
5703
5704         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5705         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5706         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5707         assert_eq!(spend_txn.len(), 3);
5708         check_spends!(spend_txn[0], local_txn_1[0]);
5709         assert_eq!(spend_txn[1].input.len(), 1);
5710         check_spends!(spend_txn[1], htlc_timeout);
5711         assert_eq!(spend_txn[1].input[0].sequence, BREAKDOWN_TIMEOUT as u32);
5712         assert_eq!(spend_txn[2].input.len(), 2);
5713         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5714         assert!(spend_txn[2].input[0].sequence == BREAKDOWN_TIMEOUT as u32 ||
5715                 spend_txn[2].input[1].sequence == BREAKDOWN_TIMEOUT as u32);
5716 }
5717
5718 #[test]
5719 fn test_static_output_closing_tx() {
5720         let chanmon_cfgs = create_chanmon_cfgs(2);
5721         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5722         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5723         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5724
5725         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5726
5727         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5728         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5729
5730         mine_transaction(&nodes[0], &closing_tx);
5731         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
5732         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5733
5734         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5735         assert_eq!(spend_txn.len(), 1);
5736         check_spends!(spend_txn[0], closing_tx);
5737
5738         mine_transaction(&nodes[1], &closing_tx);
5739         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
5740         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5741
5742         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5743         assert_eq!(spend_txn.len(), 1);
5744         check_spends!(spend_txn[0], closing_tx);
5745 }
5746
5747 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5748         let chanmon_cfgs = create_chanmon_cfgs(2);
5749         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5750         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5751         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5752         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5753
5754         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5755
5756         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5757         // present in B's local commitment transaction, but none of A's commitment transactions.
5758         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5759         check_added_monitors!(nodes[1], 1);
5760
5761         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5762         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5763         let events = nodes[0].node.get_and_clear_pending_events();
5764         assert_eq!(events.len(), 1);
5765         match events[0] {
5766                 Event::PaymentSent { payment_preimage } => {
5767                         assert_eq!(payment_preimage, our_payment_preimage);
5768                 },
5769                 _ => panic!("Unexpected event"),
5770         }
5771
5772         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5773         check_added_monitors!(nodes[0], 1);
5774         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5775         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5776         check_added_monitors!(nodes[1], 1);
5777
5778         let starting_block = nodes[1].best_block_info();
5779         let mut block = Block {
5780                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5781                 txdata: vec![],
5782         };
5783         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5784                 connect_block(&nodes[1], &block);
5785                 block.header.prev_blockhash = block.block_hash();
5786         }
5787         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5788         check_closed_broadcast!(nodes[1], true);
5789         check_added_monitors!(nodes[1], 1);
5790         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
5791 }
5792
5793 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5794         let chanmon_cfgs = create_chanmon_cfgs(2);
5795         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5796         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5797         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5798         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5799         let logger = test_utils::TestLogger::new();
5800
5801         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5802         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5803         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();
5804         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5805         check_added_monitors!(nodes[0], 1);
5806
5807         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5808
5809         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5810         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5811         // to "time out" the HTLC.
5812
5813         let starting_block = nodes[1].best_block_info();
5814         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5815
5816         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5817                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5818                 header.prev_blockhash = header.block_hash();
5819         }
5820         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5821         check_closed_broadcast!(nodes[0], true);
5822         check_added_monitors!(nodes[0], 1);
5823         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxBroadcasted);
5824 }
5825
5826 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5827         let chanmon_cfgs = create_chanmon_cfgs(3);
5828         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5829         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5830         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5831         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5832
5833         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5834         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5835         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5836         // actually revoked.
5837         let htlc_value = if use_dust { 50000 } else { 3000000 };
5838         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5839         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5840         expect_pending_htlcs_forwardable!(nodes[1]);
5841         check_added_monitors!(nodes[1], 1);
5842
5843         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5844         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5845         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5846         check_added_monitors!(nodes[0], 1);
5847         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5848         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5849         check_added_monitors!(nodes[1], 1);
5850         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5851         check_added_monitors!(nodes[1], 1);
5852         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5853
5854         if check_revoke_no_close {
5855                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5856                 check_added_monitors!(nodes[0], 1);
5857         }
5858
5859         let starting_block = nodes[1].best_block_info();
5860         let mut block = Block {
5861                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5862                 txdata: vec![],
5863         };
5864         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5865                 connect_block(&nodes[0], &block);
5866                 block.header.prev_blockhash = block.block_hash();
5867         }
5868         if !check_revoke_no_close {
5869                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5870                 check_closed_broadcast!(nodes[0], true);
5871                 check_added_monitors!(nodes[0], 1);
5872                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxBroadcasted);
5873         } else {
5874                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5875         }
5876 }
5877
5878 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5879 // There are only a few cases to test here:
5880 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5881 //    broadcastable commitment transactions result in channel closure,
5882 //  * its included in an unrevoked-but-previous remote commitment transaction,
5883 //  * its included in the latest remote or local commitment transactions.
5884 // We test each of the three possible commitment transactions individually and use both dust and
5885 // non-dust HTLCs.
5886 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5887 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5888 // tested for at least one of the cases in other tests.
5889 #[test]
5890 fn htlc_claim_single_commitment_only_a() {
5891         do_htlc_claim_local_commitment_only(true);
5892         do_htlc_claim_local_commitment_only(false);
5893
5894         do_htlc_claim_current_remote_commitment_only(true);
5895         do_htlc_claim_current_remote_commitment_only(false);
5896 }
5897
5898 #[test]
5899 fn htlc_claim_single_commitment_only_b() {
5900         do_htlc_claim_previous_remote_commitment_only(true, false);
5901         do_htlc_claim_previous_remote_commitment_only(false, false);
5902         do_htlc_claim_previous_remote_commitment_only(true, true);
5903         do_htlc_claim_previous_remote_commitment_only(false, true);
5904 }
5905
5906 #[test]
5907 #[should_panic]
5908 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5909         let chanmon_cfgs = create_chanmon_cfgs(2);
5910         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5911         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5912         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5913         //Force duplicate channel ids
5914         for node in nodes.iter() {
5915                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5916         }
5917
5918         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5919         let channel_value_satoshis=10000;
5920         let push_msat=10001;
5921         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5922         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5923         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5924
5925         //Create a second channel with a channel_id collision
5926         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5927 }
5928
5929 #[test]
5930 fn bolt2_open_channel_sending_node_checks_part2() {
5931         let chanmon_cfgs = create_chanmon_cfgs(2);
5932         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5933         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5934         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5935
5936         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5937         let channel_value_satoshis=2^24;
5938         let push_msat=10001;
5939         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5940
5941         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5942         let channel_value_satoshis=10000;
5943         // Test when push_msat is equal to 1000 * funding_satoshis.
5944         let push_msat=1000*channel_value_satoshis+1;
5945         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5946
5947         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5948         let channel_value_satoshis=10000;
5949         let push_msat=10001;
5950         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
5951         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5952         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5953
5954         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5955         // 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
5956         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5957
5958         // 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.
5959         assert!(BREAKDOWN_TIMEOUT>0);
5960         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5961
5962         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5963         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5964         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5965
5966         // 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.
5967         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5968         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5969         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5970         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5971         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5972 }
5973
5974 #[test]
5975 fn bolt2_open_channel_sane_dust_limit() {
5976         let chanmon_cfgs = create_chanmon_cfgs(2);
5977         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5978         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5979         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5980
5981         let channel_value_satoshis=1000000;
5982         let push_msat=10001;
5983         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5984         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5985         node0_to_1_send_open_channel.dust_limit_satoshis = 661;
5986         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
5987
5988         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5989         let events = nodes[1].node.get_and_clear_pending_msg_events();
5990         let err_msg = match events[0] {
5991                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
5992                         msg.clone()
5993                 },
5994                 _ => panic!("Unexpected event"),
5995         };
5996         assert_eq!(err_msg.data, "dust_limit_satoshis (661) is greater than the implementation limit (660)");
5997 }
5998
5999 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6000 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6001 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6002 // is no longer affordable once it's freed.
6003 #[test]
6004 fn test_fail_holding_cell_htlc_upon_free() {
6005         let chanmon_cfgs = create_chanmon_cfgs(2);
6006         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6007         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6008         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6009         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6010         let logger = test_utils::TestLogger::new();
6011
6012         // First nodes[0] generates an update_fee, setting the channel's
6013         // pending_update_fee.
6014         {
6015                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
6016                 *feerate_lock += 20;
6017         }
6018         nodes[0].node.timer_tick_occurred();
6019         check_added_monitors!(nodes[0], 1);
6020
6021         let events = nodes[0].node.get_and_clear_pending_msg_events();
6022         assert_eq!(events.len(), 1);
6023         let (update_msg, commitment_signed) = match events[0] {
6024                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6025                         (update_fee.as_ref(), commitment_signed)
6026                 },
6027                 _ => panic!("Unexpected event"),
6028         };
6029
6030         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6031
6032         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6033         let channel_reserve = chan_stat.channel_reserve_msat;
6034         let feerate = get_feerate!(nodes[0], chan.2);
6035
6036         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6037         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6038         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6039         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6040         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();
6041
6042         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6043         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6044         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6045         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6046
6047         // Flush the pending fee update.
6048         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6049         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6050         check_added_monitors!(nodes[1], 1);
6051         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6052         check_added_monitors!(nodes[0], 1);
6053
6054         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6055         // HTLC, but now that the fee has been raised the payment will now fail, causing
6056         // us to surface its failure to the user.
6057         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6058         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6059         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);
6060         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 {}",
6061                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6062         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6063
6064         // Check that the payment failed to be sent out.
6065         let events = nodes[0].node.get_and_clear_pending_events();
6066         assert_eq!(events.len(), 1);
6067         match &events[0] {
6068                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed } => {
6069                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6070                         assert_eq!(*rejected_by_dest, false);
6071                         assert_eq!(*all_paths_failed, true);
6072                         assert_eq!(*network_update, None);
6073                         assert_eq!(*error_code, None);
6074                         assert_eq!(*error_data, None);
6075                 },
6076                 _ => panic!("Unexpected event"),
6077         }
6078 }
6079
6080 // Test that if multiple HTLCs are released from the holding cell and one is
6081 // valid but the other is no longer valid upon release, the valid HTLC can be
6082 // successfully completed while the other one fails as expected.
6083 #[test]
6084 fn test_free_and_fail_holding_cell_htlcs() {
6085         let chanmon_cfgs = create_chanmon_cfgs(2);
6086         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6087         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6088         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6089         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6090         let logger = test_utils::TestLogger::new();
6091
6092         // First nodes[0] generates an update_fee, setting the channel's
6093         // pending_update_fee.
6094         {
6095                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
6096                 *feerate_lock += 200;
6097         }
6098         nodes[0].node.timer_tick_occurred();
6099         check_added_monitors!(nodes[0], 1);
6100
6101         let events = nodes[0].node.get_and_clear_pending_msg_events();
6102         assert_eq!(events.len(), 1);
6103         let (update_msg, commitment_signed) = match events[0] {
6104                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6105                         (update_fee.as_ref(), commitment_signed)
6106                 },
6107                 _ => panic!("Unexpected event"),
6108         };
6109
6110         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6111
6112         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6113         let channel_reserve = chan_stat.channel_reserve_msat;
6114         let feerate = get_feerate!(nodes[0], chan.2);
6115
6116         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6117         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
6118         let amt_1 = 20000;
6119         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6120         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6121         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6122         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();
6123         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();
6124
6125         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6126         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6127         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6128         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6129         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6130         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6131         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6132
6133         // Flush the pending fee update.
6134         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6135         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6136         check_added_monitors!(nodes[1], 1);
6137         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6138         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6139         check_added_monitors!(nodes[0], 2);
6140
6141         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6142         // but now that the fee has been raised the second payment will now fail, causing us
6143         // to surface its failure to the user. The first payment should succeed.
6144         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6145         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6146         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);
6147         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 {}",
6148                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
6149         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6150
6151         // Check that the second payment failed to be sent out.
6152         let events = nodes[0].node.get_and_clear_pending_events();
6153         assert_eq!(events.len(), 1);
6154         match &events[0] {
6155                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref network_update, ref error_code, ref error_data, ref all_paths_failed } => {
6156                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6157                         assert_eq!(*rejected_by_dest, false);
6158                         assert_eq!(*all_paths_failed, true);
6159                         assert_eq!(*network_update, None);
6160                         assert_eq!(*error_code, None);
6161                         assert_eq!(*error_data, None);
6162                 },
6163                 _ => panic!("Unexpected event"),
6164         }
6165
6166         // Complete the first payment and the RAA from the fee update.
6167         let (payment_event, send_raa_event) = {
6168                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6169                 assert_eq!(msgs.len(), 2);
6170                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6171         };
6172         let raa = match send_raa_event {
6173                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6174                 _ => panic!("Unexpected event"),
6175         };
6176         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6177         check_added_monitors!(nodes[1], 1);
6178         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6179         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6180         let events = nodes[1].node.get_and_clear_pending_events();
6181         assert_eq!(events.len(), 1);
6182         match events[0] {
6183                 Event::PendingHTLCsForwardable { .. } => {},
6184                 _ => panic!("Unexpected event"),
6185         }
6186         nodes[1].node.process_pending_htlc_forwards();
6187         let events = nodes[1].node.get_and_clear_pending_events();
6188         assert_eq!(events.len(), 1);
6189         match events[0] {
6190                 Event::PaymentReceived { .. } => {},
6191                 _ => panic!("Unexpected event"),
6192         }
6193         nodes[1].node.claim_funds(payment_preimage_1);
6194         check_added_monitors!(nodes[1], 1);
6195         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6196         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6197         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6198         let events = nodes[0].node.get_and_clear_pending_events();
6199         assert_eq!(events.len(), 1);
6200         match events[0] {
6201                 Event::PaymentSent { ref payment_preimage } => {
6202                         assert_eq!(*payment_preimage, payment_preimage_1);
6203                 }
6204                 _ => panic!("Unexpected event"),
6205         }
6206 }
6207
6208 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6209 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6210 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6211 // once it's freed.
6212 #[test]
6213 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6214         let chanmon_cfgs = create_chanmon_cfgs(3);
6215         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6216         // When this test was written, the default base fee floated based on the HTLC count.
6217         // It is now fixed, so we simply set the fee to the expected value here.
6218         let mut config = test_default_channel_config();
6219         config.channel_options.forwarding_fee_base_msat = 196;
6220         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
6221         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6222         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6223         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6224         let logger = test_utils::TestLogger::new();
6225
6226         // First nodes[1] generates an update_fee, setting the channel's
6227         // pending_update_fee.
6228         {
6229                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
6230                 *feerate_lock += 20;
6231         }
6232         nodes[1].node.timer_tick_occurred();
6233         check_added_monitors!(nodes[1], 1);
6234
6235         let events = nodes[1].node.get_and_clear_pending_msg_events();
6236         assert_eq!(events.len(), 1);
6237         let (update_msg, commitment_signed) = match events[0] {
6238                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6239                         (update_fee.as_ref(), commitment_signed)
6240                 },
6241                 _ => panic!("Unexpected event"),
6242         };
6243
6244         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6245
6246         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6247         let channel_reserve = chan_stat.channel_reserve_msat;
6248         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6249
6250         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6251         let feemsat = 239;
6252         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6253         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6254         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6255         let payment_event = {
6256                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6257                 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();
6258                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6259                 check_added_monitors!(nodes[0], 1);
6260
6261                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6262                 assert_eq!(events.len(), 1);
6263
6264                 SendEvent::from_event(events.remove(0))
6265         };
6266         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6267         check_added_monitors!(nodes[1], 0);
6268         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6269         expect_pending_htlcs_forwardable!(nodes[1]);
6270
6271         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6272         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6273
6274         // Flush the pending fee update.
6275         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6276         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6277         check_added_monitors!(nodes[2], 1);
6278         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6279         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6280         check_added_monitors!(nodes[1], 2);
6281
6282         // A final RAA message is generated to finalize the fee update.
6283         let events = nodes[1].node.get_and_clear_pending_msg_events();
6284         assert_eq!(events.len(), 1);
6285
6286         let raa_msg = match &events[0] {
6287                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6288                         msg.clone()
6289                 },
6290                 _ => panic!("Unexpected event"),
6291         };
6292
6293         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6294         check_added_monitors!(nodes[2], 1);
6295         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6296
6297         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6298         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6299         assert_eq!(process_htlc_forwards_event.len(), 1);
6300         match &process_htlc_forwards_event[0] {
6301                 &Event::PendingHTLCsForwardable { .. } => {},
6302                 _ => panic!("Unexpected event"),
6303         }
6304
6305         // In response, we call ChannelManager's process_pending_htlc_forwards
6306         nodes[1].node.process_pending_htlc_forwards();
6307         check_added_monitors!(nodes[1], 1);
6308
6309         // This causes the HTLC to be failed backwards.
6310         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6311         assert_eq!(fail_event.len(), 1);
6312         let (fail_msg, commitment_signed) = match &fail_event[0] {
6313                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6314                         assert_eq!(updates.update_add_htlcs.len(), 0);
6315                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6316                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6317                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6318                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6319                 },
6320                 _ => panic!("Unexpected event"),
6321         };
6322
6323         // Pass the failure messages back to nodes[0].
6324         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6325         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6326
6327         // Complete the HTLC failure+removal process.
6328         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6329         check_added_monitors!(nodes[0], 1);
6330         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6331         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6332         check_added_monitors!(nodes[1], 2);
6333         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6334         assert_eq!(final_raa_event.len(), 1);
6335         let raa = match &final_raa_event[0] {
6336                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6337                 _ => panic!("Unexpected event"),
6338         };
6339         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6340         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_1_2.0.contents.short_channel_id, false);
6341         check_added_monitors!(nodes[0], 1);
6342 }
6343
6344 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6345 // 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.
6346 //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.
6347
6348 #[test]
6349 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6350         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6351         let chanmon_cfgs = create_chanmon_cfgs(2);
6352         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6353         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6354         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6355         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6356
6357         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6358         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6359         let logger = test_utils::TestLogger::new();
6360         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();
6361         route.paths[0][0].fee_msat = 100;
6362
6363         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6364                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6365         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6366         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6367 }
6368
6369 #[test]
6370 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6371         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6372         let chanmon_cfgs = create_chanmon_cfgs(2);
6373         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6374         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6375         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6376         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6377         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6378
6379         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6380         let logger = test_utils::TestLogger::new();
6381         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();
6382         route.paths[0][0].fee_msat = 0;
6383         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6384                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6385
6386         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6387         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6388 }
6389
6390 #[test]
6391 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6392         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6393         let chanmon_cfgs = create_chanmon_cfgs(2);
6394         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6395         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6396         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6397         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6398
6399         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6400         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6401         let logger = test_utils::TestLogger::new();
6402         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6403         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6404         check_added_monitors!(nodes[0], 1);
6405         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6406         updates.update_add_htlcs[0].amount_msat = 0;
6407
6408         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6409         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6410         check_closed_broadcast!(nodes[1], true).unwrap();
6411         check_added_monitors!(nodes[1], 1);
6412         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote side tried to send a 0-msat HTLC".to_string() });
6413 }
6414
6415 #[test]
6416 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6417         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6418         //It is enforced when constructing a route.
6419         let chanmon_cfgs = create_chanmon_cfgs(2);
6420         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6421         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6422         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6423         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6424         let logger = test_utils::TestLogger::new();
6425
6426         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6427
6428         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6429         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();
6430         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6431                 assert_eq!(err, &"Channel CLTV overflowed?"));
6432 }
6433
6434 #[test]
6435 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6436         //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.
6437         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6438         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6439         let chanmon_cfgs = create_chanmon_cfgs(2);
6440         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6441         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6442         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6443         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6444         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6445
6446         let logger = test_utils::TestLogger::new();
6447         for i in 0..max_accepted_htlcs {
6448                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6449                 let payment_event = {
6450                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6451                         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();
6452                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6453                         check_added_monitors!(nodes[0], 1);
6454
6455                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6456                         assert_eq!(events.len(), 1);
6457                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6458                                 assert_eq!(htlcs[0].htlc_id, i);
6459                         } else {
6460                                 assert!(false);
6461                         }
6462                         SendEvent::from_event(events.remove(0))
6463                 };
6464                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6465                 check_added_monitors!(nodes[1], 0);
6466                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6467
6468                 expect_pending_htlcs_forwardable!(nodes[1]);
6469                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6470         }
6471         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6472         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6473         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();
6474         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6475                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6476
6477         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6478         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6479 }
6480
6481 #[test]
6482 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6483         //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.
6484         let chanmon_cfgs = create_chanmon_cfgs(2);
6485         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6486         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6487         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6488         let channel_value = 100000;
6489         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6490         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6491
6492         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6493
6494         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6495         // Manually create a route over our max in flight (which our router normally automatically
6496         // limits us to.
6497         let route = Route { paths: vec![vec![RouteHop {
6498            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6499            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6500            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6501         }]] };
6502         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6503                 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)));
6504
6505         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6506         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);
6507
6508         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6509 }
6510
6511 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6512 #[test]
6513 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6514         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6515         let chanmon_cfgs = create_chanmon_cfgs(2);
6516         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6517         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6518         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6519         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6520         let htlc_minimum_msat: u64;
6521         {
6522                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6523                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6524                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6525         }
6526
6527         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6528         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6529         let logger = test_utils::TestLogger::new();
6530         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();
6531         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6532         check_added_monitors!(nodes[0], 1);
6533         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6534         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6535         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6536         assert!(nodes[1].node.list_channels().is_empty());
6537         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6538         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()));
6539         check_added_monitors!(nodes[1], 1);
6540         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote side tried to send less than our minimum HTLC value. Lower limit: (1000). Actual: (999)".to_string() });
6541 }
6542
6543 #[test]
6544 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6545         //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
6546         let chanmon_cfgs = create_chanmon_cfgs(2);
6547         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6548         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6549         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6550         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6551         let logger = test_utils::TestLogger::new();
6552
6553         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6554         let channel_reserve = chan_stat.channel_reserve_msat;
6555         let feerate = get_feerate!(nodes[0], chan.2);
6556         // The 2* and +1 are for the fee spike reserve.
6557         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6558
6559         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6560         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6561         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6562         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();
6563         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6564         check_added_monitors!(nodes[0], 1);
6565         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6566
6567         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6568         // at this time channel-initiatee receivers are not required to enforce that senders
6569         // respect the fee_spike_reserve.
6570         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6571         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6572
6573         assert!(nodes[1].node.list_channels().is_empty());
6574         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6575         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6576         check_added_monitors!(nodes[1], 1);
6577         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote HTLC add would put them under remote reserve value".to_string() });
6578 }
6579
6580 #[test]
6581 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6582         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6583         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6584         let chanmon_cfgs = create_chanmon_cfgs(2);
6585         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6586         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6587         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6588         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6589         let logger = test_utils::TestLogger::new();
6590
6591         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6592         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6593
6594         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6595         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();
6596
6597         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6598         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6599         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6600         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6601
6602         let mut msg = msgs::UpdateAddHTLC {
6603                 channel_id: chan.2,
6604                 htlc_id: 0,
6605                 amount_msat: 1000,
6606                 payment_hash: our_payment_hash,
6607                 cltv_expiry: htlc_cltv,
6608                 onion_routing_packet: onion_packet.clone(),
6609         };
6610
6611         for i in 0..super::channel::OUR_MAX_HTLCS {
6612                 msg.htlc_id = i as u64;
6613                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6614         }
6615         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6616         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6617
6618         assert!(nodes[1].node.list_channels().is_empty());
6619         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6620         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6621         check_added_monitors!(nodes[1], 1);
6622         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote tried to push more than our max accepted HTLCs (50)".to_string() });
6623 }
6624
6625 #[test]
6626 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6627         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6628         let chanmon_cfgs = create_chanmon_cfgs(2);
6629         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6630         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6631         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6632         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6633         let logger = test_utils::TestLogger::new();
6634
6635         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6636         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6637         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6638         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6639         check_added_monitors!(nodes[0], 1);
6640         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6641         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6642         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6643
6644         assert!(nodes[1].node.list_channels().is_empty());
6645         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6646         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6647         check_added_monitors!(nodes[1], 1);
6648         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote HTLC add would put them over our max HTLC value (100000000)".to_string() });
6649 }
6650
6651 #[test]
6652 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6653         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6654         let chanmon_cfgs = create_chanmon_cfgs(2);
6655         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6656         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6657         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6658         let logger = test_utils::TestLogger::new();
6659
6660         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6661         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6662         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6663         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();
6664         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6665         check_added_monitors!(nodes[0], 1);
6666         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6667         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6668         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6669
6670         assert!(nodes[1].node.list_channels().is_empty());
6671         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6672         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6673         check_added_monitors!(nodes[1], 1);
6674         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote provided CLTV expiry in seconds instead of block height".to_string() });
6675 }
6676
6677 #[test]
6678 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6679         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6680         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6681         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6682         let chanmon_cfgs = create_chanmon_cfgs(2);
6683         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6684         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6685         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6686         let logger = test_utils::TestLogger::new();
6687
6688         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6689         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6690         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6691         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();
6692         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6693         check_added_monitors!(nodes[0], 1);
6694         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6695         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6696
6697         //Disconnect and Reconnect
6698         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6699         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6700         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6701         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6702         assert_eq!(reestablish_1.len(), 1);
6703         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6704         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6705         assert_eq!(reestablish_2.len(), 1);
6706         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6707         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6708         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6709         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6710
6711         //Resend HTLC
6712         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6713         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6714         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6715         check_added_monitors!(nodes[1], 1);
6716         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6717
6718         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6719
6720         assert!(nodes[1].node.list_channels().is_empty());
6721         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6722         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6723         check_added_monitors!(nodes[1], 1);
6724         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote skipped HTLC ID (skipped ID: 1)".to_string() });
6725 }
6726
6727 #[test]
6728 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6729         //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.
6730
6731         let chanmon_cfgs = create_chanmon_cfgs(2);
6732         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6733         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6734         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6735         let logger = test_utils::TestLogger::new();
6736         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6737         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6738         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6739         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();
6740         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6741
6742         check_added_monitors!(nodes[0], 1);
6743         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6744         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6745
6746         let update_msg = msgs::UpdateFulfillHTLC{
6747                 channel_id: chan.2,
6748                 htlc_id: 0,
6749                 payment_preimage: our_payment_preimage,
6750         };
6751
6752         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6753
6754         assert!(nodes[0].node.list_channels().is_empty());
6755         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6756         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()));
6757         check_added_monitors!(nodes[0], 1);
6758         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Remote tried to fulfill/fail HTLC (0) before it had been committed".to_string() });
6759 }
6760
6761 #[test]
6762 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6763         //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.
6764
6765         let chanmon_cfgs = create_chanmon_cfgs(2);
6766         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6767         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6768         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6769         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6770         let logger = test_utils::TestLogger::new();
6771
6772         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6773         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6774         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();
6775         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6776         check_added_monitors!(nodes[0], 1);
6777         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6778         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6779
6780         let update_msg = msgs::UpdateFailHTLC{
6781                 channel_id: chan.2,
6782                 htlc_id: 0,
6783                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6784         };
6785
6786         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6787
6788         assert!(nodes[0].node.list_channels().is_empty());
6789         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6790         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()));
6791         check_added_monitors!(nodes[0], 1);
6792         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Remote tried to fulfill/fail HTLC (0) before it had been committed".to_string() });
6793 }
6794
6795 #[test]
6796 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6797         //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.
6798
6799         let chanmon_cfgs = create_chanmon_cfgs(2);
6800         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6801         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6802         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6803         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6804         let logger = test_utils::TestLogger::new();
6805
6806         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6807         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6808         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();
6809         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6810         check_added_monitors!(nodes[0], 1);
6811         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6812         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6813         let update_msg = msgs::UpdateFailMalformedHTLC{
6814                 channel_id: chan.2,
6815                 htlc_id: 0,
6816                 sha256_of_onion: [1; 32],
6817                 failure_code: 0x8000,
6818         };
6819
6820         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6821
6822         assert!(nodes[0].node.list_channels().is_empty());
6823         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6824         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()));
6825         check_added_monitors!(nodes[0], 1);
6826         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Remote tried to fulfill/fail HTLC (0) before it had been committed".to_string() });
6827 }
6828
6829 #[test]
6830 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6831         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6832
6833         let chanmon_cfgs = create_chanmon_cfgs(2);
6834         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6835         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6836         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6837         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6838
6839         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6840
6841         nodes[1].node.claim_funds(our_payment_preimage);
6842         check_added_monitors!(nodes[1], 1);
6843
6844         let events = nodes[1].node.get_and_clear_pending_msg_events();
6845         assert_eq!(events.len(), 1);
6846         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6847                 match events[0] {
6848                         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, .. } } => {
6849                                 assert!(update_add_htlcs.is_empty());
6850                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6851                                 assert!(update_fail_htlcs.is_empty());
6852                                 assert!(update_fail_malformed_htlcs.is_empty());
6853                                 assert!(update_fee.is_none());
6854                                 update_fulfill_htlcs[0].clone()
6855                         },
6856                         _ => panic!("Unexpected event"),
6857                 }
6858         };
6859
6860         update_fulfill_msg.htlc_id = 1;
6861
6862         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6863
6864         assert!(nodes[0].node.list_channels().is_empty());
6865         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6866         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6867         check_added_monitors!(nodes[0], 1);
6868         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Remote tried to fulfill/fail an HTLC we couldn\'t find".to_string()});
6869 }
6870
6871 #[test]
6872 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6873         //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.
6874
6875         let chanmon_cfgs = create_chanmon_cfgs(2);
6876         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6877         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6878         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6879         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6880
6881         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6882
6883         nodes[1].node.claim_funds(our_payment_preimage);
6884         check_added_monitors!(nodes[1], 1);
6885
6886         let events = nodes[1].node.get_and_clear_pending_msg_events();
6887         assert_eq!(events.len(), 1);
6888         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6889                 match events[0] {
6890                         MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, .. } } => {
6891                                 assert!(update_add_htlcs.is_empty());
6892                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6893                                 assert!(update_fail_htlcs.is_empty());
6894                                 assert!(update_fail_malformed_htlcs.is_empty());
6895                                 assert!(update_fee.is_none());
6896                                 update_fulfill_htlcs[0].clone()
6897                         },
6898                         _ => panic!("Unexpected event"),
6899                 }
6900         };
6901
6902         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6903
6904         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6905
6906         assert!(nodes[0].node.list_channels().is_empty());
6907         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6908         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6909         check_added_monitors!(nodes[0], 1);
6910         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Remote tried to fulfill HTLC (0) with an incorrect preimage".to_string() });
6911 }
6912
6913 #[test]
6914 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6915         //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.
6916
6917         let chanmon_cfgs = create_chanmon_cfgs(2);
6918         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6919         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6920         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6921         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6922         let logger = test_utils::TestLogger::new();
6923
6924         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6925         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6926         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();
6927         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6928         check_added_monitors!(nodes[0], 1);
6929
6930         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6931         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6932
6933         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6934         check_added_monitors!(nodes[1], 0);
6935         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6936
6937         let events = nodes[1].node.get_and_clear_pending_msg_events();
6938
6939         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6940                 match events[0] {
6941                         MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, .. } } => {
6942                                 assert!(update_add_htlcs.is_empty());
6943                                 assert!(update_fulfill_htlcs.is_empty());
6944                                 assert!(update_fail_htlcs.is_empty());
6945                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6946                                 assert!(update_fee.is_none());
6947                                 update_fail_malformed_htlcs[0].clone()
6948                         },
6949                         _ => panic!("Unexpected event"),
6950                 }
6951         };
6952         update_msg.failure_code &= !0x8000;
6953         nodes[0].node.handle_update_fail_malformed_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_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6958         check_added_monitors!(nodes[0], 1);
6959         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Got update_fail_malformed_htlc with BADONION not set".to_string() });
6960 }
6961
6962 #[test]
6963 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6964         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6965         //    * 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.
6966
6967         let chanmon_cfgs = create_chanmon_cfgs(3);
6968         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6969         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6970         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6971         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6972         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6973         let logger = test_utils::TestLogger::new();
6974
6975         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6976
6977         //First hop
6978         let mut payment_event = {
6979                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6980                 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();
6981                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6982                 check_added_monitors!(nodes[0], 1);
6983                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6984                 assert_eq!(events.len(), 1);
6985                 SendEvent::from_event(events.remove(0))
6986         };
6987         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6988         check_added_monitors!(nodes[1], 0);
6989         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6990         expect_pending_htlcs_forwardable!(nodes[1]);
6991         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6992         assert_eq!(events_2.len(), 1);
6993         check_added_monitors!(nodes[1], 1);
6994         payment_event = SendEvent::from_event(events_2.remove(0));
6995         assert_eq!(payment_event.msgs.len(), 1);
6996
6997         //Second Hop
6998         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6999         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7000         check_added_monitors!(nodes[2], 0);
7001         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7002
7003         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7004         assert_eq!(events_3.len(), 1);
7005         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7006                 match events_3[0] {
7007                         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 } } => {
7008                                 assert!(update_add_htlcs.is_empty());
7009                                 assert!(update_fulfill_htlcs.is_empty());
7010                                 assert!(update_fail_htlcs.is_empty());
7011                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7012                                 assert!(update_fee.is_none());
7013                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7014                         },
7015                         _ => panic!("Unexpected event"),
7016                 }
7017         };
7018
7019         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7020
7021         check_added_monitors!(nodes[1], 0);
7022         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7023         expect_pending_htlcs_forwardable!(nodes[1]);
7024         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7025         assert_eq!(events_4.len(), 1);
7026
7027         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7028         match events_4[0] {
7029                 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, .. } } => {
7030                         assert!(update_add_htlcs.is_empty());
7031                         assert!(update_fulfill_htlcs.is_empty());
7032                         assert_eq!(update_fail_htlcs.len(), 1);
7033                         assert!(update_fail_malformed_htlcs.is_empty());
7034                         assert!(update_fee.is_none());
7035                 },
7036                 _ => panic!("Unexpected event"),
7037         };
7038
7039         check_added_monitors!(nodes[1], 1);
7040 }
7041
7042 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7043         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7044         // 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
7045         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7046
7047         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7048         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7049         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7050         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7051         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7052         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7053
7054         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7055
7056         // We route 2 dust-HTLCs between A and B
7057         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7058         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7059         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7060
7061         // Cache one local commitment tx as previous
7062         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7063
7064         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7065         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
7066         check_added_monitors!(nodes[1], 0);
7067         expect_pending_htlcs_forwardable!(nodes[1]);
7068         check_added_monitors!(nodes[1], 1);
7069
7070         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7071         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7072         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7073         check_added_monitors!(nodes[0], 1);
7074
7075         // Cache one local commitment tx as lastest
7076         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7077
7078         let events = nodes[0].node.get_and_clear_pending_msg_events();
7079         match events[0] {
7080                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7081                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7082                 },
7083                 _ => panic!("Unexpected event"),
7084         }
7085         match events[1] {
7086                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7087                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7088                 },
7089                 _ => panic!("Unexpected event"),
7090         }
7091
7092         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7093         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7094         if announce_latest {
7095                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
7096         } else {
7097                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
7098         }
7099
7100         check_closed_broadcast!(nodes[0], true);
7101         check_added_monitors!(nodes[0], 1);
7102         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxBroadcasted);
7103
7104         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7105         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7106         let events = nodes[0].node.get_and_clear_pending_events();
7107         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7108         assert_eq!(events.len(), 2);
7109         let mut first_failed = false;
7110         for event in events {
7111                 match event {
7112                         Event::PaymentFailed { payment_hash, .. } => {
7113                                 if payment_hash == payment_hash_1 {
7114                                         assert!(!first_failed);
7115                                         first_failed = true;
7116                                 } else {
7117                                         assert_eq!(payment_hash, payment_hash_2);
7118                                 }
7119                         }
7120                         _ => panic!("Unexpected event"),
7121                 }
7122         }
7123 }
7124
7125 #[test]
7126 fn test_failure_delay_dust_htlc_local_commitment() {
7127         do_test_failure_delay_dust_htlc_local_commitment(true);
7128         do_test_failure_delay_dust_htlc_local_commitment(false);
7129 }
7130
7131 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7132         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7133         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7134         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7135         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7136         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7137         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7138
7139         let chanmon_cfgs = create_chanmon_cfgs(3);
7140         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7141         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7142         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7143         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7144
7145         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7146
7147         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7148         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7149
7150         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7151         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7152
7153         // We revoked bs_commitment_tx
7154         if revoked {
7155                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7156                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7157         }
7158
7159         let mut timeout_tx = Vec::new();
7160         if local {
7161                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7162                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7163                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxBroadcasted);
7164                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7165                 expect_payment_failed!(nodes[0], dust_hash, true);
7166
7167                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
7168                 check_closed_broadcast!(nodes[0], true);
7169                 check_added_monitors!(nodes[0], 1);
7170                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7171                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7172                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7173                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7174                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7175                 mine_transaction(&nodes[0], &timeout_tx[0]);
7176                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7177                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7178         } else {
7179                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7180                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7181                 check_closed_broadcast!(nodes[0], true);
7182                 check_added_monitors!(nodes[0], 1);
7183                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxBroadcasted);
7184                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7185                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7186                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
7187                 if !revoked {
7188                         expect_payment_failed!(nodes[0], dust_hash, true);
7189                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7190                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7191                         mine_transaction(&nodes[0], &timeout_tx[0]);
7192                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7193                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7194                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7195                 } else {
7196                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7197                         // commitment tx
7198                         let events = nodes[0].node.get_and_clear_pending_events();
7199                         assert_eq!(events.len(), 2);
7200                         let first;
7201                         match events[0] {
7202                                 Event::PaymentFailed { payment_hash, .. } => {
7203                                         if payment_hash == dust_hash { first = true; }
7204                                         else { first = false; }
7205                                 },
7206                                 _ => panic!("Unexpected event"),
7207                         }
7208                         match events[1] {
7209                                 Event::PaymentFailed { payment_hash, .. } => {
7210                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7211                                         else { assert_eq!(payment_hash, dust_hash); }
7212                                 },
7213                                 _ => panic!("Unexpected event"),
7214                         }
7215                 }
7216         }
7217 }
7218
7219 #[test]
7220 fn test_sweep_outbound_htlc_failure_update() {
7221         do_test_sweep_outbound_htlc_failure_update(false, true);
7222         do_test_sweep_outbound_htlc_failure_update(false, false);
7223         do_test_sweep_outbound_htlc_failure_update(true, false);
7224 }
7225
7226 #[test]
7227 fn test_user_configurable_csv_delay() {
7228         // We test our channel constructors yield errors when we pass them absurd csv delay
7229
7230         let mut low_our_to_self_config = UserConfig::default();
7231         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7232         let mut high_their_to_self_config = UserConfig::default();
7233         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7234         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7235         let chanmon_cfgs = create_chanmon_cfgs(2);
7236         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7237         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7238         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7239
7240         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7241         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) {
7242                 match error {
7243                         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())); },
7244                         _ => panic!("Unexpected event"),
7245                 }
7246         } else { assert!(false) }
7247
7248         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7249         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7250         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7251         open_channel.to_self_delay = 200;
7252         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) {
7253                 match error {
7254                         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()));  },
7255                         _ => panic!("Unexpected event"),
7256                 }
7257         } else { assert!(false); }
7258
7259         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7260         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7261         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()));
7262         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7263         accept_channel.to_self_delay = 200;
7264         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7265         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7266                 match action {
7267                         &ErrorAction::SendErrorMessage { ref msg } => {
7268                                 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()));
7269                         },
7270                         _ => { assert!(false); }
7271                 }
7272         } else { assert!(false); }
7273         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "They wanted our payments to be delayed by a needlessly long period. Upper limit: 100. Actual: 200".to_string() });
7274
7275         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7276         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7277         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7278         open_channel.to_self_delay = 200;
7279         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) {
7280                 match error {
7281                         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())); },
7282                         _ => panic!("Unexpected event"),
7283                 }
7284         } else { assert!(false); }
7285 }
7286
7287 #[test]
7288 fn test_data_loss_protect() {
7289         // We want to be sure that :
7290         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7291         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7292         // * we close channel in case of detecting other being fallen behind
7293         // * we are able to claim our own outputs thanks to to_remote being static
7294         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7295         let persister;
7296         let logger;
7297         let fee_estimator;
7298         let tx_broadcaster;
7299         let chain_source;
7300         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7301         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7302         // during signing due to revoked tx
7303         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7304         let keys_manager = &chanmon_cfgs[0].keys_manager;
7305         let monitor;
7306         let node_state_0;
7307         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7308         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7309         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7310
7311         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7312
7313         // Cache node A state before any channel update
7314         let previous_node_state = nodes[0].node.encode();
7315         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7316         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7317
7318         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7319         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7320
7321         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7322         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7323
7324         // Restore node A from previous state
7325         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7326         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7327         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7328         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7329         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7330         persister = test_utils::TestPersister::new();
7331         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7332         node_state_0 = {
7333                 let mut channel_monitors = HashMap::new();
7334                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7335                 <(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 {
7336                         keys_manager: keys_manager,
7337                         fee_estimator: &fee_estimator,
7338                         chain_monitor: &monitor,
7339                         logger: &logger,
7340                         tx_broadcaster: &tx_broadcaster,
7341                         default_config: UserConfig::default(),
7342                         channel_monitors,
7343                 }).unwrap().1
7344         };
7345         nodes[0].node = &node_state_0;
7346         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7347         nodes[0].chain_monitor = &monitor;
7348         nodes[0].chain_source = &chain_source;
7349
7350         check_added_monitors!(nodes[0], 1);
7351
7352         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7353         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7354
7355         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7356
7357         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7358         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7359         check_added_monitors!(nodes[0], 1);
7360
7361         {
7362                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7363                 assert_eq!(node_txn.len(), 0);
7364         }
7365
7366         let mut reestablish_1 = Vec::with_capacity(1);
7367         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7368                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7369                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7370                         reestablish_1.push(msg.clone());
7371                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7372                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7373                         match action {
7374                                 &ErrorAction::SendErrorMessage { ref msg } => {
7375                                         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");
7376                                 },
7377                                 _ => panic!("Unexpected event!"),
7378                         }
7379                 } else {
7380                         panic!("Unexpected event")
7381                 }
7382         }
7383
7384         // Check we close channel detecting A is fallen-behind
7385         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7386         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Peer attempted to reestablish channel with a very old local commitment transaction".to_string() });
7387         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7388         check_added_monitors!(nodes[1], 1);
7389
7390         // Check A is able to claim to_remote output
7391         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7392         assert_eq!(node_txn.len(), 1);
7393         check_spends!(node_txn[0], chan.3);
7394         assert_eq!(node_txn[0].output.len(), 2);
7395         mine_transaction(&nodes[0], &node_txn[0]);
7396         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7397         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() });
7398         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
7399         assert_eq!(spend_txn.len(), 1);
7400         check_spends!(spend_txn[0], node_txn[0]);
7401 }
7402
7403 #[test]
7404 fn test_check_htlc_underpaying() {
7405         // Send payment through A -> B but A is maliciously
7406         // sending a probe payment (i.e less than expected value0
7407         // to B, B should refuse payment.
7408
7409         let chanmon_cfgs = create_chanmon_cfgs(2);
7410         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7411         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7412         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7413
7414         // Create some initial channels
7415         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7416
7417         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();
7418         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7419         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7420         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7421         check_added_monitors!(nodes[0], 1);
7422
7423         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7424         assert_eq!(events.len(), 1);
7425         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7426         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7427         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7428
7429         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7430         // and then will wait a second random delay before failing the HTLC back:
7431         expect_pending_htlcs_forwardable!(nodes[1]);
7432         expect_pending_htlcs_forwardable!(nodes[1]);
7433
7434         // Node 3 is expecting payment of 100_000 but received 10_000,
7435         // it should fail htlc like we didn't know the preimage.
7436         nodes[1].node.process_pending_htlc_forwards();
7437
7438         let events = nodes[1].node.get_and_clear_pending_msg_events();
7439         assert_eq!(events.len(), 1);
7440         let (update_fail_htlc, commitment_signed) = match events[0] {
7441                 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 } } => {
7442                         assert!(update_add_htlcs.is_empty());
7443                         assert!(update_fulfill_htlcs.is_empty());
7444                         assert_eq!(update_fail_htlcs.len(), 1);
7445                         assert!(update_fail_malformed_htlcs.is_empty());
7446                         assert!(update_fee.is_none());
7447                         (update_fail_htlcs[0].clone(), commitment_signed)
7448                 },
7449                 _ => panic!("Unexpected event"),
7450         };
7451         check_added_monitors!(nodes[1], 1);
7452
7453         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7454         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7455
7456         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7457         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7458         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7459         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7460 }
7461
7462 #[test]
7463 fn test_announce_disable_channels() {
7464         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7465         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7466
7467         let chanmon_cfgs = create_chanmon_cfgs(2);
7468         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7469         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7470         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7471
7472         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7473         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7474         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7475
7476         // Disconnect peers
7477         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7478         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7479
7480         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
7481         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
7482         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7483         assert_eq!(msg_events.len(), 3);
7484         let mut chans_disabled: HashSet<u64> = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7485         for e in msg_events {
7486                 match e {
7487                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7488                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
7489                                 // Check that each channel gets updated exactly once
7490                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7491                                         panic!("Generated ChannelUpdate for wrong chan!");
7492                                 }
7493                         },
7494                         _ => panic!("Unexpected event"),
7495                 }
7496         }
7497         // Reconnect peers
7498         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7499         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7500         assert_eq!(reestablish_1.len(), 3);
7501         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7502         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7503         assert_eq!(reestablish_2.len(), 3);
7504
7505         // Reestablish chan_1
7506         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7507         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7508         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7509         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7510         // Reestablish chan_2
7511         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7512         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7513         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7514         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7515         // Reestablish chan_3
7516         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7517         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7518         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7519         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7520
7521         nodes[0].node.timer_tick_occurred();
7522         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7523         nodes[0].node.timer_tick_occurred();
7524         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7525         assert_eq!(msg_events.len(), 3);
7526         chans_disabled = [short_id_1, short_id_2, short_id_3].iter().map(|a| *a).collect();
7527         for e in msg_events {
7528                 match e {
7529                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7530                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7531                                 // Check that each channel gets updated exactly once
7532                                 if !chans_disabled.remove(&msg.contents.short_channel_id) {
7533                                         panic!("Generated ChannelUpdate for wrong chan!");
7534                                 }
7535                         },
7536                         _ => panic!("Unexpected event"),
7537                 }
7538         }
7539 }
7540
7541 #[test]
7542 fn test_priv_forwarding_rejection() {
7543         // If we have a private channel with outbound liquidity, and
7544         // UserConfig::accept_forwards_to_priv_channels is set to false, we should reject any attempts
7545         // to forward through that channel.
7546         let chanmon_cfgs = create_chanmon_cfgs(3);
7547         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7548         let mut no_announce_cfg = test_default_channel_config();
7549         no_announce_cfg.channel_options.announced_channel = false;
7550         no_announce_cfg.accept_forwards_to_priv_channels = false;
7551         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(no_announce_cfg), None]);
7552         let persister: test_utils::TestPersister;
7553         let new_chain_monitor: test_utils::TestChainMonitor;
7554         let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
7555         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7556
7557         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
7558
7559         // Note that the create_*_chan functions in utils requires announcement_signatures, which we do
7560         // not send for private channels.
7561         nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7562         let open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[2].node.get_our_node_id());
7563         nodes[2].node.handle_open_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7564         let accept_channel = get_event_msg!(nodes[2], MessageSendEvent::SendAcceptChannel, nodes[1].node.get_our_node_id());
7565         nodes[1].node.handle_accept_channel(&nodes[2].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7566
7567         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[1], 1_000_000, 42);
7568         nodes[1].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
7569         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()));
7570         check_added_monitors!(nodes[2], 1);
7571
7572         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()));
7573         check_added_monitors!(nodes[1], 1);
7574
7575         let conf_height = core::cmp::max(nodes[1].best_block_info().1 + 1, nodes[2].best_block_info().1 + 1);
7576         confirm_transaction_at(&nodes[1], &tx, conf_height);
7577         connect_blocks(&nodes[1], CHAN_CONFIRM_DEPTH - 1);
7578         confirm_transaction_at(&nodes[2], &tx, conf_height);
7579         connect_blocks(&nodes[2], CHAN_CONFIRM_DEPTH - 1);
7580         let as_funding_locked = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[2].node.get_our_node_id());
7581         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()));
7582         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7583         nodes[2].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &as_funding_locked);
7584         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7585
7586         assert!(nodes[0].node.list_usable_channels()[0].is_public);
7587         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
7588         assert!(!nodes[2].node.list_usable_channels()[0].is_public);
7589
7590         // We should always be able to forward through nodes[1] as long as its out through a public
7591         // channel:
7592         send_payment(&nodes[2], &[&nodes[1], &nodes[0]], 10_000);
7593
7594         // ... however, if we send to nodes[2], we will have to pass the private channel from nodes[1]
7595         // to nodes[2], which should be rejected:
7596         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
7597         let route = get_route(&nodes[0].node.get_our_node_id(),
7598                 &nodes[0].net_graph_msg_handler.network_graph,
7599                 &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None,
7600                 &[&RouteHint(vec![RouteHintHop {
7601                         src_node_id: nodes[1].node.get_our_node_id(),
7602                         short_channel_id: nodes[2].node.list_channels()[0].short_channel_id.unwrap(),
7603                         fees: RoutingFees { base_msat: 1000, proportional_millionths: 0 },
7604                         cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
7605                         htlc_minimum_msat: None,
7606                         htlc_maximum_msat: None,
7607                 }])], 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7608
7609         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7610         check_added_monitors!(nodes[0], 1);
7611         let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7612         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7613         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
7614
7615         let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7616         assert!(htlc_fail_updates.update_add_htlcs.is_empty());
7617         assert_eq!(htlc_fail_updates.update_fail_htlcs.len(), 1);
7618         assert!(htlc_fail_updates.update_fail_malformed_htlcs.is_empty());
7619         assert!(htlc_fail_updates.update_fee.is_none());
7620
7621         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
7622         commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, true, true);
7623         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, nodes[2].node.list_channels()[0].short_channel_id.unwrap(), true);
7624
7625         // Now disconnect nodes[1] from its peers and restart with accept_forwards_to_priv_channels set
7626         // to true. Sadly there is currently no way to change it at runtime.
7627
7628         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7629         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7630
7631         let nodes_1_serialized = nodes[1].node.encode();
7632         let mut monitor_a_serialized = test_utils::TestVecWriter(Vec::new());
7633         let mut monitor_b_serialized = test_utils::TestVecWriter(Vec::new());
7634         {
7635                 let mons = nodes[1].chain_monitor.chain_monitor.monitors.read().unwrap();
7636                 let mut mon_iter = mons.iter();
7637                 mon_iter.next().unwrap().1.write(&mut monitor_a_serialized).unwrap();
7638                 mon_iter.next().unwrap().1.write(&mut monitor_b_serialized).unwrap();
7639         }
7640
7641         persister = test_utils::TestPersister::new();
7642         let keys_manager = &chanmon_cfgs[1].keys_manager;
7643         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);
7644         nodes[1].chain_monitor = &new_chain_monitor;
7645
7646         let mut monitor_a_read = &monitor_a_serialized.0[..];
7647         let mut monitor_b_read = &monitor_b_serialized.0[..];
7648         let (_, mut monitor_a) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_a_read, keys_manager).unwrap();
7649         let (_, mut monitor_b) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut monitor_b_read, keys_manager).unwrap();
7650         assert!(monitor_a_read.is_empty());
7651         assert!(monitor_b_read.is_empty());
7652
7653         no_announce_cfg.accept_forwards_to_priv_channels = true;
7654
7655         let mut nodes_1_read = &nodes_1_serialized[..];
7656         let (_, nodes_1_deserialized_tmp) = {
7657                 let mut channel_monitors = HashMap::new();
7658                 channel_monitors.insert(monitor_a.get_funding_txo().0, &mut monitor_a);
7659                 channel_monitors.insert(monitor_b.get_funding_txo().0, &mut monitor_b);
7660                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_1_read, ChannelManagerReadArgs {
7661                         default_config: no_announce_cfg,
7662                         keys_manager,
7663                         fee_estimator: node_cfgs[1].fee_estimator,
7664                         chain_monitor: nodes[1].chain_monitor,
7665                         tx_broadcaster: nodes[1].tx_broadcaster.clone(),
7666                         logger: nodes[1].logger,
7667                         channel_monitors,
7668                 }).unwrap()
7669         };
7670         assert!(nodes_1_read.is_empty());
7671         nodes_1_deserialized = nodes_1_deserialized_tmp;
7672
7673         assert!(nodes[1].chain_monitor.watch_channel(monitor_a.get_funding_txo().0, monitor_a).is_ok());
7674         assert!(nodes[1].chain_monitor.watch_channel(monitor_b.get_funding_txo().0, monitor_b).is_ok());
7675         check_added_monitors!(nodes[1], 2);
7676         nodes[1].node = &nodes_1_deserialized;
7677
7678         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7679         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7680         let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7681         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
7682         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish);
7683         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7684         get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7685         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
7686
7687         nodes[1].node.peer_connected(&nodes[2].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known() });
7688         nodes[2].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7689         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[2].node.get_our_node_id());
7690         let cs_reestablish = get_event_msg!(nodes[2], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7691         nodes[2].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
7692         nodes[1].node.handle_channel_reestablish(&nodes[2].node.get_our_node_id(), &cs_reestablish);
7693         get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[2].node.get_our_node_id());
7694         get_event_msg!(nodes[2], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
7695
7696         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7697         check_added_monitors!(nodes[0], 1);
7698         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 10_000, our_payment_hash, our_payment_secret);
7699         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], our_payment_preimage);
7700 }
7701
7702 #[test]
7703 fn test_bump_penalty_txn_on_revoked_commitment() {
7704         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7705         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7706
7707         let chanmon_cfgs = create_chanmon_cfgs(2);
7708         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7709         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7710         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7711
7712         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7713         let logger = test_utils::TestLogger::new();
7714
7715         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7716         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7717         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();
7718         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7719
7720         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7721         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7722         assert_eq!(revoked_txn[0].output.len(), 4);
7723         assert_eq!(revoked_txn[0].input.len(), 1);
7724         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7725         let revoked_txid = revoked_txn[0].txid();
7726
7727         let mut penalty_sum = 0;
7728         for outp in revoked_txn[0].output.iter() {
7729                 if outp.script_pubkey.is_v0_p2wsh() {
7730                         penalty_sum += outp.value;
7731                 }
7732         }
7733
7734         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7735         let header_114 = connect_blocks(&nodes[1], 14);
7736
7737         // Actually revoke tx by claiming a HTLC
7738         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7739         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7740         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7741         check_added_monitors!(nodes[1], 1);
7742
7743         // One or more justice tx should have been broadcast, check it
7744         let penalty_1;
7745         let feerate_1;
7746         {
7747                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7748                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7749                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7750                 assert_eq!(node_txn[0].output.len(), 1);
7751                 check_spends!(node_txn[0], revoked_txn[0]);
7752                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7753                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7754                 penalty_1 = node_txn[0].txid();
7755                 node_txn.clear();
7756         };
7757
7758         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7759         connect_blocks(&nodes[1], 15);
7760         let mut penalty_2 = penalty_1;
7761         let mut feerate_2 = 0;
7762         {
7763                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7764                 assert_eq!(node_txn.len(), 1);
7765                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7766                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7767                         assert_eq!(node_txn[0].output.len(), 1);
7768                         check_spends!(node_txn[0], revoked_txn[0]);
7769                         penalty_2 = node_txn[0].txid();
7770                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7771                         assert_ne!(penalty_2, penalty_1);
7772                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7773                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7774                         // Verify 25% bump heuristic
7775                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7776                         node_txn.clear();
7777                 }
7778         }
7779         assert_ne!(feerate_2, 0);
7780
7781         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7782         connect_blocks(&nodes[1], 1);
7783         let penalty_3;
7784         let mut feerate_3 = 0;
7785         {
7786                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7787                 assert_eq!(node_txn.len(), 1);
7788                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7789                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7790                         assert_eq!(node_txn[0].output.len(), 1);
7791                         check_spends!(node_txn[0], revoked_txn[0]);
7792                         penalty_3 = node_txn[0].txid();
7793                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7794                         assert_ne!(penalty_3, penalty_2);
7795                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7796                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7797                         // Verify 25% bump heuristic
7798                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7799                         node_txn.clear();
7800                 }
7801         }
7802         assert_ne!(feerate_3, 0);
7803
7804         nodes[1].node.get_and_clear_pending_events();
7805         nodes[1].node.get_and_clear_pending_msg_events();
7806 }
7807
7808 #[test]
7809 fn test_bump_penalty_txn_on_revoked_htlcs() {
7810         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7811         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7812
7813         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7814         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7815         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7816         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7817         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7818
7819         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7820         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7821         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph,
7822                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7823         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7824         let route = get_route(&nodes[1].node.get_our_node_id(), &nodes[1].net_graph_msg_handler.network_graph,
7825                 &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3_000_000, 50, nodes[0].logger).unwrap();
7826         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7827
7828         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7829         assert_eq!(revoked_local_txn[0].input.len(), 1);
7830         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7831
7832         // Revoke local commitment tx
7833         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7834
7835         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7836         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7837         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7838         check_closed_broadcast!(nodes[1], true);
7839         check_added_monitors!(nodes[1], 1);
7840         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
7841         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
7842
7843         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7844         assert_eq!(revoked_htlc_txn.len(), 3);
7845         check_spends!(revoked_htlc_txn[1], chan.3);
7846
7847         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7848         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7849         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7850
7851         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
7852         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7853         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
7854         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
7855
7856         // Broadcast set of revoked txn on A
7857         let hash_128 = connect_blocks(&nodes[0], 40);
7858         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7859         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7860         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7861         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
7862         let events = nodes[0].node.get_and_clear_pending_events();
7863         expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
7864         match events[1] {
7865                 Event::ChannelClosed { .. } => {}
7866                 _ => panic!("Unexpected event"),
7867         }
7868         let first;
7869         let feerate_1;
7870         let penalty_txn;
7871         {
7872                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7873                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7874                 // Verify claim tx are spending revoked HTLC txn
7875
7876                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7877                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7878                 // which are included in the same block (they are broadcasted because we scan the
7879                 // transactions linearly and generate claims as we go, they likely should be removed in the
7880                 // future).
7881                 assert_eq!(node_txn[0].input.len(), 1);
7882                 check_spends!(node_txn[0], revoked_local_txn[0]);
7883                 assert_eq!(node_txn[1].input.len(), 1);
7884                 check_spends!(node_txn[1], revoked_local_txn[0]);
7885                 assert_eq!(node_txn[2].input.len(), 1);
7886                 check_spends!(node_txn[2], revoked_local_txn[0]);
7887
7888                 // Each of the three justice transactions claim a separate (single) output of the three
7889                 // available, which we check here:
7890                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7891                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7892                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7893
7894                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7895                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7896
7897                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7898                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7899                 // a remote commitment tx has already been confirmed).
7900                 check_spends!(node_txn[3], chan.3);
7901
7902                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7903                 // output, checked above).
7904                 assert_eq!(node_txn[4].input.len(), 2);
7905                 assert_eq!(node_txn[4].output.len(), 1);
7906                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7907
7908                 first = node_txn[4].txid();
7909                 // Store both feerates for later comparison
7910                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
7911                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7912                 penalty_txn = vec![node_txn[2].clone()];
7913                 node_txn.clear();
7914         }
7915
7916         // Connect one more block to see if bumped penalty are issued for HTLC txn
7917         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7918         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7919         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7920         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7921         {
7922                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7923                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7924
7925                 check_spends!(node_txn[0], revoked_local_txn[0]);
7926                 check_spends!(node_txn[1], revoked_local_txn[0]);
7927                 // Note that these are both bogus - they spend outputs already claimed in block 129:
7928                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
7929                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7930                 } else {
7931                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7932                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7933                 }
7934
7935                 node_txn.clear();
7936         };
7937
7938         // Few more blocks to confirm penalty txn
7939         connect_blocks(&nodes[0], 4);
7940         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7941         let header_144 = connect_blocks(&nodes[0], 9);
7942         let node_txn = {
7943                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7944                 assert_eq!(node_txn.len(), 1);
7945
7946                 assert_eq!(node_txn[0].input.len(), 2);
7947                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7948                 // Verify bumped tx is different and 25% bump heuristic
7949                 assert_ne!(first, node_txn[0].txid());
7950                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
7951                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7952                 assert!(feerate_2 * 100 > feerate_1 * 125);
7953                 let txn = vec![node_txn[0].clone()];
7954                 node_txn.clear();
7955                 txn
7956         };
7957         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7958         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7959         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
7960         connect_blocks(&nodes[0], 20);
7961         {
7962                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7963                 // We verify than no new transaction has been broadcast because previously
7964                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7965                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7966                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7967                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7968                 // up bumped justice generation.
7969                 assert_eq!(node_txn.len(), 0);
7970                 node_txn.clear();
7971         }
7972         check_closed_broadcast!(nodes[0], true);
7973         check_added_monitors!(nodes[0], 1);
7974 }
7975
7976 #[test]
7977 fn test_bump_penalty_txn_on_remote_commitment() {
7978         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7979         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7980
7981         // Create 2 HTLCs
7982         // Provide preimage for one
7983         // Check aggregation
7984
7985         let chanmon_cfgs = create_chanmon_cfgs(2);
7986         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7987         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7988         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7989
7990         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7991         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7992         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7993
7994         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7995         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7996         assert_eq!(remote_txn[0].output.len(), 4);
7997         assert_eq!(remote_txn[0].input.len(), 1);
7998         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7999
8000         // Claim a HTLC without revocation (provide B monitor with preimage)
8001         nodes[1].node.claim_funds(payment_preimage);
8002         mine_transaction(&nodes[1], &remote_txn[0]);
8003         check_added_monitors!(nodes[1], 2);
8004         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
8005
8006         // One or more claim tx should have been broadcast, check it
8007         let timeout;
8008         let preimage;
8009         let preimage_bump;
8010         let feerate_timeout;
8011         let feerate_preimage;
8012         {
8013                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8014                 // 9 transactions including:
8015                 // 1*2 ChannelManager local broadcasts of commitment + HTLC-Success
8016                 // 1*3 ChannelManager local broadcasts of commitment + HTLC-Success + HTLC-Timeout
8017                 // 2 * HTLC-Success (one RBF bump we'll check later)
8018                 // 1 * HTLC-Timeout
8019                 assert_eq!(node_txn.len(), 8);
8020                 assert_eq!(node_txn[0].input.len(), 1);
8021                 assert_eq!(node_txn[6].input.len(), 1);
8022                 check_spends!(node_txn[0], remote_txn[0]);
8023                 check_spends!(node_txn[6], remote_txn[0]);
8024                 assert_eq!(node_txn[0].input[0].previous_output, node_txn[3].input[0].previous_output);
8025                 preimage_bump = node_txn[3].clone();
8026
8027                 check_spends!(node_txn[1], chan.3);
8028                 check_spends!(node_txn[2], node_txn[1]);
8029                 assert_eq!(node_txn[1], node_txn[4]);
8030                 assert_eq!(node_txn[2], node_txn[5]);
8031
8032                 timeout = node_txn[6].txid();
8033                 let index = node_txn[6].input[0].previous_output.vout;
8034                 let fee = remote_txn[0].output[index as usize].value - node_txn[6].output[0].value;
8035                 feerate_timeout = fee * 1000 / node_txn[6].get_weight() as u64;
8036
8037                 preimage = node_txn[0].txid();
8038                 let index = node_txn[0].input[0].previous_output.vout;
8039                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8040                 feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8041
8042                 node_txn.clear();
8043         };
8044         assert_ne!(feerate_timeout, 0);
8045         assert_ne!(feerate_preimage, 0);
8046
8047         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8048         connect_blocks(&nodes[1], 15);
8049         {
8050                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8051                 assert_eq!(node_txn.len(), 1);
8052                 assert_eq!(node_txn[0].input.len(), 1);
8053                 assert_eq!(preimage_bump.input.len(), 1);
8054                 check_spends!(node_txn[0], remote_txn[0]);
8055                 check_spends!(preimage_bump, remote_txn[0]);
8056
8057                 let index = preimage_bump.input[0].previous_output.vout;
8058                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
8059                 let new_feerate = fee * 1000 / preimage_bump.get_weight() as u64;
8060                 assert!(new_feerate * 100 > feerate_timeout * 125);
8061                 assert_ne!(timeout, preimage_bump.txid());
8062
8063                 let index = node_txn[0].input[0].previous_output.vout;
8064                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8065                 let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8066                 assert!(new_feerate * 100 > feerate_preimage * 125);
8067                 assert_ne!(preimage, node_txn[0].txid());
8068
8069                 node_txn.clear();
8070         }
8071
8072         nodes[1].node.get_and_clear_pending_events();
8073         nodes[1].node.get_and_clear_pending_msg_events();
8074 }
8075
8076 #[test]
8077 fn test_counterparty_raa_skip_no_crash() {
8078         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8079         // commitment transaction, we would have happily carried on and provided them the next
8080         // commitment transaction based on one RAA forward. This would probably eventually have led to
8081         // channel closure, but it would not have resulted in funds loss. Still, our
8082         // EnforcingSigner would have panicked as it doesn't like jumps into the future. Here, we
8083         // check simply that the channel is closed in response to such an RAA, but don't check whether
8084         // we decide to punish our counterparty for revoking their funds (as we don't currently
8085         // implement that).
8086         let chanmon_cfgs = create_chanmon_cfgs(2);
8087         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8088         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8089         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8090         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8091
8092         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8093         let keys = guard.by_id.get_mut(&channel_id).unwrap().get_signer();
8094
8095         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8096
8097         // Make signer believe we got a counterparty signature, so that it allows the revocation
8098         keys.get_enforcement_state().last_holder_commitment -= 1;
8099         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8100
8101         // Must revoke without gaps
8102         keys.get_enforcement_state().last_holder_commitment -= 1;
8103         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8104
8105         keys.get_enforcement_state().last_holder_commitment -= 1;
8106         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8107                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8108
8109         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8110                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8111         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8112         check_added_monitors!(nodes[1], 1);
8113         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Received an unexpected revoke_and_ack".to_string() });
8114 }
8115
8116 #[test]
8117 fn test_bump_txn_sanitize_tracking_maps() {
8118         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8119         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8120
8121         let chanmon_cfgs = create_chanmon_cfgs(2);
8122         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8123         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8124         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8125
8126         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8127         // Lock HTLC in both directions
8128         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8129         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8130
8131         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8132         assert_eq!(revoked_local_txn[0].input.len(), 1);
8133         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8134
8135         // Revoke local commitment tx
8136         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8137
8138         // Broadcast set of revoked txn on A
8139         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
8140         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8141         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8142
8143         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8144         check_closed_broadcast!(nodes[0], true);
8145         check_added_monitors!(nodes[0], 1);
8146         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxBroadcasted);
8147         let penalty_txn = {
8148                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8149                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8150                 check_spends!(node_txn[0], revoked_local_txn[0]);
8151                 check_spends!(node_txn[1], revoked_local_txn[0]);
8152                 check_spends!(node_txn[2], revoked_local_txn[0]);
8153                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8154                 node_txn.clear();
8155                 penalty_txn
8156         };
8157         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8158         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8159         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8160         {
8161                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8162                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8163                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8164                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8165                 }
8166         }
8167 }
8168
8169 #[test]
8170 fn test_override_channel_config() {
8171         let chanmon_cfgs = create_chanmon_cfgs(2);
8172         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8173         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8174         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8175
8176         // Node0 initiates a channel to node1 using the override config.
8177         let mut override_config = UserConfig::default();
8178         override_config.own_channel_config.our_to_self_delay = 200;
8179
8180         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8181
8182         // Assert the channel created by node0 is using the override config.
8183         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8184         assert_eq!(res.channel_flags, 0);
8185         assert_eq!(res.to_self_delay, 200);
8186 }
8187
8188 #[test]
8189 fn test_override_0msat_htlc_minimum() {
8190         let mut zero_config = UserConfig::default();
8191         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8192         let chanmon_cfgs = create_chanmon_cfgs(2);
8193         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8194         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8195         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8196
8197         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8198         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8199         assert_eq!(res.htlc_minimum_msat, 1);
8200
8201         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8202         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8203         assert_eq!(res.htlc_minimum_msat, 1);
8204 }
8205
8206 #[test]
8207 fn test_simple_mpp() {
8208         // Simple test of sending a multi-path payment.
8209         let chanmon_cfgs = create_chanmon_cfgs(4);
8210         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8211         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8212         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8213
8214         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8215         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8216         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8217         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8218         let logger = test_utils::TestLogger::new();
8219
8220         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8221         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8222         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();
8223         let path = route.paths[0].clone();
8224         route.paths.push(path);
8225         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8226         route.paths[0][0].short_channel_id = chan_1_id;
8227         route.paths[0][1].short_channel_id = chan_3_id;
8228         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8229         route.paths[1][0].short_channel_id = chan_2_id;
8230         route.paths[1][1].short_channel_id = chan_4_id;
8231         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8232         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8233 }
8234
8235 #[test]
8236 fn test_preimage_storage() {
8237         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8238         let chanmon_cfgs = create_chanmon_cfgs(2);
8239         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8240         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8241         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8242
8243         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8244
8245         {
8246                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8247
8248                 let logger = test_utils::TestLogger::new();
8249                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8250                 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();
8251                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8252                 check_added_monitors!(nodes[0], 1);
8253                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8254                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8255                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8256                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8257         }
8258         // Note that after leaving the above scope we have no knowledge of any arguments or return
8259         // values from previous calls.
8260         expect_pending_htlcs_forwardable!(nodes[1]);
8261         let events = nodes[1].node.get_and_clear_pending_events();
8262         assert_eq!(events.len(), 1);
8263         match events[0] {
8264                 Event::PaymentReceived { ref purpose, .. } => {
8265                         match &purpose {
8266                                 PaymentPurpose::InvoicePayment { payment_preimage, user_payment_id, .. } => {
8267                                         assert_eq!(*user_payment_id, 42);
8268                                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8269                                 },
8270                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
8271                         }
8272                 },
8273                 _ => panic!("Unexpected event"),
8274         }
8275 }
8276
8277 #[test]
8278 fn test_secret_timeout() {
8279         // Simple test of payment secret storage time outs
8280         let chanmon_cfgs = create_chanmon_cfgs(2);
8281         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8282         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8283         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8284
8285         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8286
8287         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8288
8289         // We should fail to register the same payment hash twice, at least until we've connected a
8290         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8291         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8292                 assert_eq!(err, "Duplicate payment hash");
8293         } else { panic!(); }
8294         let mut block = {
8295                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
8296                 Block {
8297                         header: BlockHeader {
8298                                 version: 0x2000000,
8299                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
8300                                 merkle_root: Default::default(),
8301                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
8302                         txdata: vec![],
8303                 }
8304         };
8305         connect_block(&nodes[1], &block);
8306         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8307                 assert_eq!(err, "Duplicate payment hash");
8308         } else { panic!(); }
8309
8310         // If we then connect the second block, we should be able to register the same payment hash
8311         // again with a different user_payment_id (this time getting a new payment secret).
8312         block.header.prev_blockhash = block.header.block_hash();
8313         block.header.time += 1;
8314         connect_block(&nodes[1], &block);
8315         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8316         assert_ne!(payment_secret_1, our_payment_secret);
8317
8318         {
8319                 let logger = test_utils::TestLogger::new();
8320                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8321                 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();
8322                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8323                 check_added_monitors!(nodes[0], 1);
8324                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8325                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8326                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8327                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8328         }
8329         // Note that after leaving the above scope we have no knowledge of any arguments or return
8330         // values from previous calls.
8331         expect_pending_htlcs_forwardable!(nodes[1]);
8332         let events = nodes[1].node.get_and_clear_pending_events();
8333         assert_eq!(events.len(), 1);
8334         match events[0] {
8335                 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, user_payment_id }, .. } => {
8336                         assert!(payment_preimage.is_none());
8337                         assert_eq!(user_payment_id, 42);
8338                         assert_eq!(payment_secret, our_payment_secret);
8339                         // We don't actually have the payment preimage with which to claim this payment!
8340                 },
8341                 _ => panic!("Unexpected event"),
8342         }
8343 }
8344
8345 #[test]
8346 fn test_bad_secret_hash() {
8347         // Simple test of unregistered payment hash/invalid payment secret handling
8348         let chanmon_cfgs = create_chanmon_cfgs(2);
8349         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8350         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8351         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8352
8353         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8354
8355         let random_payment_hash = PaymentHash([42; 32]);
8356         let random_payment_secret = PaymentSecret([43; 32]);
8357         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8358
8359         let logger = test_utils::TestLogger::new();
8360         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8361         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();
8362
8363         // All the below cases should end up being handled exactly identically, so we macro the
8364         // resulting events.
8365         macro_rules! handle_unknown_invalid_payment_data {
8366                 () => {
8367                         check_added_monitors!(nodes[0], 1);
8368                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8369                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8370                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8371                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8372
8373                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8374                         // again to process the pending backwards-failure of the HTLC
8375                         expect_pending_htlcs_forwardable!(nodes[1]);
8376                         expect_pending_htlcs_forwardable!(nodes[1]);
8377                         check_added_monitors!(nodes[1], 1);
8378
8379                         // We should fail the payment back
8380                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8381                         match events.pop().unwrap() {
8382                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8383                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8384                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8385                                 },
8386                                 _ => panic!("Unexpected event"),
8387                         }
8388                 }
8389         }
8390
8391         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8392         // Error data is the HTLC value (100,000) and current block height
8393         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8394
8395         // Send a payment with the right payment hash but the wrong payment secret
8396         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8397         handle_unknown_invalid_payment_data!();
8398         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8399
8400         // Send a payment with a random payment hash, but the right payment secret
8401         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8402         handle_unknown_invalid_payment_data!();
8403         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8404
8405         // Send a payment with a random payment hash and random payment secret
8406         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8407         handle_unknown_invalid_payment_data!();
8408         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8409 }
8410
8411 #[test]
8412 fn test_update_err_monitor_lockdown() {
8413         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8414         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8415         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8416         //
8417         // This scenario may happen in a watchtower setup, where watchtower process a block height
8418         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8419         // commitment at same time.
8420
8421         let chanmon_cfgs = create_chanmon_cfgs(2);
8422         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8423         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8424         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8425
8426         // Create some initial channel
8427         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8428         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8429
8430         // Rebalance the network to generate htlc in the two directions
8431         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8432
8433         // Route a HTLC from node 0 to node 1 (but don't settle)
8434         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8435
8436         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8437         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8438         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8439         let persister = test_utils::TestPersister::new();
8440         let watchtower = {
8441                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8442                 let monitor = monitors.get(&outpoint).unwrap();
8443                 let mut w = test_utils::TestVecWriter(Vec::new());
8444                 monitor.write(&mut w).unwrap();
8445                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8446                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8447                 assert!(new_monitor == *monitor);
8448                 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);
8449                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8450                 watchtower
8451         };
8452         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8453         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8454         // transaction lock time requirements here.
8455         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (header, 0));
8456         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8457
8458         // Try to update ChannelMonitor
8459         assert!(nodes[1].node.claim_funds(preimage));
8460         check_added_monitors!(nodes[1], 1);
8461         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8462         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8463         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8464         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8465                 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8466                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8467                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8468                 } else { assert!(false); }
8469         } else { assert!(false); };
8470         // Our local monitor is in-sync and hasn't processed yet timeout
8471         check_added_monitors!(nodes[0], 1);
8472         let events = nodes[0].node.get_and_clear_pending_events();
8473         assert_eq!(events.len(), 1);
8474 }
8475
8476 #[test]
8477 fn test_concurrent_monitor_claim() {
8478         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8479         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8480         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8481         // state N+1 confirms. Alice claims output from state N+1.
8482
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 mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8487
8488         // Create some initial channel
8489         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8490         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8491
8492         // Rebalance the network to generate htlc in the two directions
8493         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8494
8495         // Route a HTLC from node 0 to node 1 (but don't settle)
8496         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8497
8498         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8499         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8500         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8501         let persister = test_utils::TestPersister::new();
8502         let watchtower_alice = {
8503                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8504                 let monitor = monitors.get(&outpoint).unwrap();
8505                 let mut w = test_utils::TestVecWriter(Vec::new());
8506                 monitor.write(&mut w).unwrap();
8507                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8508                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8509                 assert!(new_monitor == *monitor);
8510                 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);
8511                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8512                 watchtower
8513         };
8514         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8515         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8516         // transaction lock time requirements here.
8517         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (header, 0));
8518         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8519
8520         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8521         {
8522                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8523                 assert_eq!(txn.len(), 2);
8524                 txn.clear();
8525         }
8526
8527         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8528         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8529         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8530         let persister = test_utils::TestPersister::new();
8531         let watchtower_bob = {
8532                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8533                 let monitor = monitors.get(&outpoint).unwrap();
8534                 let mut w = test_utils::TestVecWriter(Vec::new());
8535                 monitor.write(&mut w).unwrap();
8536                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8537                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8538                 assert!(new_monitor == *monitor);
8539                 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);
8540                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8541                 watchtower
8542         };
8543         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8544         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8545
8546         // Route another payment to generate another update with still previous HTLC pending
8547         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8548         {
8549                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8550                 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();
8551                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8552         }
8553         check_added_monitors!(nodes[1], 1);
8554
8555         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8556         assert_eq!(updates.update_add_htlcs.len(), 1);
8557         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8558         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8559                 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8560                         // Watchtower Alice should already have seen the block and reject the update
8561                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8562                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8563                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8564                 } else { assert!(false); }
8565         } else { assert!(false); };
8566         // Our local monitor is in-sync and hasn't processed yet timeout
8567         check_added_monitors!(nodes[0], 1);
8568
8569         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8570         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8571         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8572
8573         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8574         let bob_state_y;
8575         {
8576                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8577                 assert_eq!(txn.len(), 2);
8578                 bob_state_y = txn[0].clone();
8579                 txn.clear();
8580         };
8581
8582         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8583         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8584         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);
8585         {
8586                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8587                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8588                 // the onchain detection of the HTLC output
8589                 assert_eq!(htlc_txn.len(), 2);
8590                 check_spends!(htlc_txn[0], bob_state_y);
8591                 check_spends!(htlc_txn[1], bob_state_y);
8592         }
8593 }
8594
8595 #[test]
8596 fn test_pre_lockin_no_chan_closed_update() {
8597         // Test that if a peer closes a channel in response to a funding_created message we don't
8598         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8599         // message).
8600         //
8601         // Doing so would imply a channel monitor update before the initial channel monitor
8602         // registration, violating our API guarantees.
8603         //
8604         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8605         // then opening a second channel with the same funding output as the first (which is not
8606         // rejected because the first channel does not exist in the ChannelManager) and closing it
8607         // before receiving funding_signed.
8608         let chanmon_cfgs = create_chanmon_cfgs(2);
8609         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8610         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8611         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8612
8613         // Create an initial channel
8614         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8615         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8616         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8617         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8618         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8619
8620         // Move the first channel through the funding flow...
8621         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8622
8623         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8624         check_added_monitors!(nodes[0], 0);
8625
8626         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8627         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8628         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8629         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8630         check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Hi".to_string() });
8631 }
8632
8633 #[test]
8634 fn test_htlc_no_detection() {
8635         // This test is a mutation to underscore the detection logic bug we had
8636         // before #653. HTLC value routed is above the remaining balance, thus
8637         // inverting HTLC and `to_remote` output. HTLC will come second and
8638         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8639         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8640         // outputs order detection for correct spending children filtring.
8641
8642         let chanmon_cfgs = create_chanmon_cfgs(2);
8643         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8644         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8645         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8646
8647         // Create some initial channels
8648         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8649
8650         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8651         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8652         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8653         assert_eq!(local_txn[0].input.len(), 1);
8654         assert_eq!(local_txn[0].output.len(), 3);
8655         check_spends!(local_txn[0], chan_1.3);
8656
8657         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8658         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8659         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8660         // We deliberately connect the local tx twice as this should provoke a failure calling
8661         // this test before #653 fix.
8662         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);
8663         check_closed_broadcast!(nodes[0], true);
8664         check_added_monitors!(nodes[0], 1);
8665         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxBroadcasted);
8666         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8667
8668         let htlc_timeout = {
8669                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8670                 assert_eq!(node_txn[1].input.len(), 1);
8671                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8672                 check_spends!(node_txn[1], local_txn[0]);
8673                 node_txn[1].clone()
8674         };
8675
8676         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8677         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8678         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8679         expect_payment_failed!(nodes[0], our_payment_hash, true);
8680 }
8681
8682 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8683         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8684         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8685         // Carol, Alice would be the upstream node, and Carol the downstream.)
8686         //
8687         // Steps of the test:
8688         // 1) Alice sends a HTLC to Carol through Bob.
8689         // 2) Carol doesn't settle the HTLC.
8690         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8691         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8692         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8693         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8694         // 5) Carol release the preimage to Bob off-chain.
8695         // 6) Bob claims the offered output on the broadcasted commitment.
8696         let chanmon_cfgs = create_chanmon_cfgs(3);
8697         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8698         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8699         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8700
8701         // Create some initial channels
8702         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8703         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8704
8705         // Steps (1) and (2):
8706         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8707         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8708
8709         // Check that Alice's commitment transaction now contains an output for this HTLC.
8710         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8711         check_spends!(alice_txn[0], chan_ab.3);
8712         assert_eq!(alice_txn[0].output.len(), 2);
8713         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8714         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8715         assert_eq!(alice_txn.len(), 2);
8716
8717         // Steps (3) and (4):
8718         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8719         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8720         let mut force_closing_node = 0; // Alice force-closes
8721         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8722         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8723         check_closed_broadcast!(nodes[force_closing_node], true);
8724         check_added_monitors!(nodes[force_closing_node], 1);
8725         check_closed_event!(nodes[force_closing_node], 1, ClosureReason::HolderForceClosed);
8726         if go_onchain_before_fulfill {
8727                 let txn_to_broadcast = match broadcast_alice {
8728                         true => alice_txn.clone(),
8729                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8730                 };
8731                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8732                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8733                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8734                 if broadcast_alice {
8735                         check_closed_broadcast!(nodes[1], true);
8736                         check_added_monitors!(nodes[1], 1);
8737                         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
8738                 }
8739                 assert_eq!(bob_txn.len(), 1);
8740                 check_spends!(bob_txn[0], chan_ab.3);
8741         }
8742
8743         // Step (5):
8744         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8745         // process of removing the HTLC from their commitment transactions.
8746         assert!(nodes[2].node.claim_funds(payment_preimage));
8747         check_added_monitors!(nodes[2], 1);
8748         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8749         assert!(carol_updates.update_add_htlcs.is_empty());
8750         assert!(carol_updates.update_fail_htlcs.is_empty());
8751         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8752         assert!(carol_updates.update_fee.is_none());
8753         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8754
8755         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8756         expect_payment_forwarded!(nodes[1], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false);
8757         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8758         if !go_onchain_before_fulfill && broadcast_alice {
8759                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8760                 assert_eq!(events.len(), 1);
8761                 match events[0] {
8762                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8763                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8764                         },
8765                         _ => panic!("Unexpected event"),
8766                 };
8767         }
8768         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8769         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8770         // Carol<->Bob's updated commitment transaction info.
8771         check_added_monitors!(nodes[1], 2);
8772
8773         let events = nodes[1].node.get_and_clear_pending_msg_events();
8774         assert_eq!(events.len(), 2);
8775         let bob_revocation = match events[0] {
8776                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8777                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8778                         (*msg).clone()
8779                 },
8780                 _ => panic!("Unexpected event"),
8781         };
8782         let bob_updates = match events[1] {
8783                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8784                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8785                         (*updates).clone()
8786                 },
8787                 _ => panic!("Unexpected event"),
8788         };
8789
8790         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8791         check_added_monitors!(nodes[2], 1);
8792         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8793         check_added_monitors!(nodes[2], 1);
8794
8795         let events = nodes[2].node.get_and_clear_pending_msg_events();
8796         assert_eq!(events.len(), 1);
8797         let carol_revocation = match events[0] {
8798                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8799                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8800                         (*msg).clone()
8801                 },
8802                 _ => panic!("Unexpected event"),
8803         };
8804         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8805         check_added_monitors!(nodes[1], 1);
8806
8807         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8808         // here's where we put said channel's commitment tx on-chain.
8809         let mut txn_to_broadcast = alice_txn.clone();
8810         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8811         if !go_onchain_before_fulfill {
8812                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8813                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8814                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8815                 if broadcast_alice {
8816                         check_closed_broadcast!(nodes[1], true);
8817                         check_added_monitors!(nodes[1], 1);
8818                         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
8819                 }
8820                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8821                 if broadcast_alice {
8822                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8823                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8824                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8825                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8826                         // broadcasted.
8827                         assert_eq!(bob_txn.len(), 3);
8828                         check_spends!(bob_txn[1], chan_ab.3);
8829                 } else {
8830                         assert_eq!(bob_txn.len(), 2);
8831                         check_spends!(bob_txn[0], chan_ab.3);
8832                 }
8833         }
8834
8835         // Step (6):
8836         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8837         // broadcasted commitment transaction.
8838         {
8839                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8840                 if go_onchain_before_fulfill {
8841                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8842                         assert_eq!(bob_txn.len(), 2);
8843                 }
8844                 let script_weight = match broadcast_alice {
8845                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8846                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8847                 };
8848                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8849                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8850                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8851                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8852                 if broadcast_alice && !go_onchain_before_fulfill {
8853                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8854                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8855                 } else {
8856                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8857                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8858                 }
8859         }
8860 }
8861
8862 #[test]
8863 fn test_onchain_htlc_settlement_after_close() {
8864         do_test_onchain_htlc_settlement_after_close(true, true);
8865         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8866         do_test_onchain_htlc_settlement_after_close(true, false);
8867         do_test_onchain_htlc_settlement_after_close(false, false);
8868 }
8869
8870 #[test]
8871 fn test_duplicate_chan_id() {
8872         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8873         // already open we reject it and keep the old channel.
8874         //
8875         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8876         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8877         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8878         // updating logic for the existing channel.
8879         let chanmon_cfgs = create_chanmon_cfgs(2);
8880         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8881         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8882         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8883
8884         // Create an initial channel
8885         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8886         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8887         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8888         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()));
8889
8890         // Try to create a second channel with the same temporary_channel_id as the first and check
8891         // that it is rejected.
8892         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8893         {
8894                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8895                 assert_eq!(events.len(), 1);
8896                 match events[0] {
8897                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8898                                 // Technically, at this point, nodes[1] would be justified in thinking both the
8899                                 // first (valid) and second (invalid) channels are closed, given they both have
8900                                 // the same non-temporary channel_id. However, currently we do not, so we just
8901                                 // move forward with it.
8902                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8903                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8904                         },
8905                         _ => panic!("Unexpected event"),
8906                 }
8907         }
8908
8909         // Move the first channel through the funding flow...
8910         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8911
8912         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8913         check_added_monitors!(nodes[0], 0);
8914
8915         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8916         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8917         {
8918                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8919                 assert_eq!(added_monitors.len(), 1);
8920                 assert_eq!(added_monitors[0].0, funding_output);
8921                 added_monitors.clear();
8922         }
8923         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8924
8925         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8926         let channel_id = funding_outpoint.to_channel_id();
8927
8928         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8929         // temporary one).
8930
8931         // First try to open a second channel with a temporary channel id equal to the txid-based one.
8932         // Technically this is allowed by the spec, but we don't support it and there's little reason
8933         // to. Still, it shouldn't cause any other issues.
8934         open_chan_msg.temporary_channel_id = channel_id;
8935         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8936         {
8937                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8938                 assert_eq!(events.len(), 1);
8939                 match events[0] {
8940                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8941                                 // Technically, at this point, nodes[1] would be justified in thinking both
8942                                 // channels are closed, but currently we do not, so we just move forward with it.
8943                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8944                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8945                         },
8946                         _ => panic!("Unexpected event"),
8947                 }
8948         }
8949
8950         // Now try to create a second channel which has a duplicate funding output.
8951         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8952         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8953         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8954         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()));
8955         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8956
8957         let funding_created = {
8958                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8959                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8960                 let logger = test_utils::TestLogger::new();
8961                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8962         };
8963         check_added_monitors!(nodes[0], 0);
8964         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8965         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8966         // still needs to be cleared here.
8967         check_added_monitors!(nodes[1], 1);
8968
8969         // ...still, nodes[1] will reject the duplicate channel.
8970         {
8971                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8972                 assert_eq!(events.len(), 1);
8973                 match events[0] {
8974                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8975                                 // Technically, at this point, nodes[1] would be justified in thinking both
8976                                 // channels are closed, but currently we do not, so we just move forward with it.
8977                                 assert_eq!(msg.channel_id, channel_id);
8978                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8979                         },
8980                         _ => panic!("Unexpected event"),
8981                 }
8982         }
8983
8984         // finally, finish creating the original channel and send a payment over it to make sure
8985         // everything is functional.
8986         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8987         {
8988                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8989                 assert_eq!(added_monitors.len(), 1);
8990                 assert_eq!(added_monitors[0].0, funding_output);
8991                 added_monitors.clear();
8992         }
8993
8994         let events_4 = nodes[0].node.get_and_clear_pending_events();
8995         assert_eq!(events_4.len(), 0);
8996         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8997         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
8998
8999         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9000         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9001         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9002         send_payment(&nodes[0], &[&nodes[1]], 8000000);
9003 }
9004
9005 #[test]
9006 fn test_error_chans_closed() {
9007         // Test that we properly handle error messages, closing appropriate channels.
9008         //
9009         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
9010         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
9011         // we can test various edge cases around it to ensure we don't regress.
9012         let chanmon_cfgs = create_chanmon_cfgs(3);
9013         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9014         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9015         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9016
9017         // Create some initial channels
9018         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9019         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9020         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9021
9022         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9023         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
9024         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
9025
9026         // Closing a channel from a different peer has no effect
9027         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
9028         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
9029
9030         // Closing one channel doesn't impact others
9031         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
9032         check_added_monitors!(nodes[0], 1);
9033         check_closed_broadcast!(nodes[0], false);
9034         check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
9035         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
9036         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
9037         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);
9038         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);
9039
9040         // A null channel ID should close all channels
9041         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9042         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
9043         check_added_monitors!(nodes[0], 2);
9044         check_closed_event!(nodes[0], 2, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
9045         let events = nodes[0].node.get_and_clear_pending_msg_events();
9046         assert_eq!(events.len(), 2);
9047         match events[0] {
9048                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9049                         assert_eq!(msg.contents.flags & 2, 2);
9050                 },
9051                 _ => panic!("Unexpected event"),
9052         }
9053         match events[1] {
9054                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
9055                         assert_eq!(msg.contents.flags & 2, 2);
9056                 },
9057                 _ => panic!("Unexpected event"),
9058         }
9059         // Note that at this point users of a standard PeerHandler will end up calling
9060         // peer_disconnected with no_connection_possible set to false, duplicating the
9061         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
9062         // users with their own peer handling logic. We duplicate the call here, however.
9063         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9064         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9065
9066         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
9067         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
9068         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
9069 }
9070
9071 #[test]
9072 fn test_invalid_funding_tx() {
9073         // Test that we properly handle invalid funding transactions sent to us from a peer.
9074         //
9075         // Previously, all other major lightning implementations had failed to properly sanitize
9076         // funding transactions from their counterparties, leading to a multi-implementation critical
9077         // security vulnerability (though we always sanitized properly, we've previously had
9078         // un-released crashes in the sanitization process).
9079         let chanmon_cfgs = create_chanmon_cfgs(2);
9080         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9081         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9082         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9083
9084         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
9085         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()));
9086         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()));
9087
9088         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
9089         for output in tx.output.iter_mut() {
9090                 // Make the confirmed funding transaction have a bogus script_pubkey
9091                 output.script_pubkey = bitcoin::Script::new();
9092         }
9093
9094         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
9095         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()));
9096         check_added_monitors!(nodes[1], 1);
9097
9098         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()));
9099         check_added_monitors!(nodes[0], 1);
9100
9101         let events_1 = nodes[0].node.get_and_clear_pending_events();
9102         assert_eq!(events_1.len(), 0);
9103
9104         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
9105         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
9106         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
9107
9108         confirm_transaction_at(&nodes[1], &tx, 1);
9109         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxBroadcasted);
9110         check_added_monitors!(nodes[1], 1);
9111         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
9112         assert_eq!(events_2.len(), 1);
9113         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
9114                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
9115                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
9116                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
9117                 } else { panic!(); }
9118         } else { panic!(); }
9119         assert_eq!(nodes[1].node.list_channels().len(), 0);
9120 }
9121
9122 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
9123         // In the first version of the chain::Confirm interface, after a refactor was made to not
9124         // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
9125         // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
9126         // `best_block_updated` is at height N, and a transaction output which we wish to spend at
9127         // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
9128         // spending transaction until height N+1 (or greater). This was due to the way
9129         // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
9130         // spending transaction at the height the input transaction was confirmed at, not whether we
9131         // should broadcast a spending transaction at the current height.
9132         // A second, similar, issue involved failing HTLCs backwards - because we only provided the
9133         // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
9134         // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
9135         // until we learned about an additional block.
9136         //
9137         // As an additional check, if `test_height_before_timelock` is set, we instead test that we
9138         // aren't broadcasting transactions too early (ie not broadcasting them at all).
9139         let chanmon_cfgs = create_chanmon_cfgs(3);
9140         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
9141         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
9142         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
9143         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
9144
9145         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
9146         let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
9147         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
9148         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
9149         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
9150
9151         nodes[1].node.force_close_channel(&channel_id).unwrap();
9152         check_closed_broadcast!(nodes[1], true);
9153         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
9154         check_added_monitors!(nodes[1], 1);
9155         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9156         assert_eq!(node_txn.len(), 1);
9157
9158         let conf_height = nodes[1].best_block_info().1;
9159         if !test_height_before_timelock {
9160                 connect_blocks(&nodes[1], 24 * 6);
9161         }
9162         nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9163                 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
9164         if test_height_before_timelock {
9165                 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
9166                 // generate any events or broadcast any transactions
9167                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
9168                 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
9169         } else {
9170                 // We should broadcast an HTLC transaction spending our funding transaction first
9171                 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
9172                 assert_eq!(spending_txn.len(), 2);
9173                 assert_eq!(spending_txn[0], node_txn[0]);
9174                 check_spends!(spending_txn[1], node_txn[0]);
9175                 // We should also generate a SpendableOutputs event with the to_self output (as its
9176                 // timelock is up).
9177                 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
9178                 assert_eq!(descriptor_spend_txn.len(), 1);
9179
9180                 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
9181                 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
9182                 // additional block built on top of the current chain.
9183                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
9184                         &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
9185                 expect_pending_htlcs_forwardable!(nodes[1]);
9186                 check_added_monitors!(nodes[1], 1);
9187
9188                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
9189                 assert!(updates.update_add_htlcs.is_empty());
9190                 assert!(updates.update_fulfill_htlcs.is_empty());
9191                 assert_eq!(updates.update_fail_htlcs.len(), 1);
9192                 assert!(updates.update_fail_malformed_htlcs.is_empty());
9193                 assert!(updates.update_fee.is_none());
9194                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
9195                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
9196                 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_announce.contents.short_channel_id, true);
9197         }
9198 }
9199
9200 #[test]
9201 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
9202         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
9203         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
9204 }
9205
9206 #[test]
9207 fn test_keysend_payments_to_public_node() {
9208         let chanmon_cfgs = create_chanmon_cfgs(2);
9209         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9210         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9211         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9212
9213         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
9214         let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9215         let payer_pubkey = nodes[0].node.get_our_node_id();
9216         let payee_pubkey = nodes[1].node.get_our_node_id();
9217         let route = get_route(&payer_pubkey, network_graph, &payee_pubkey, None,
9218                         None, &vec![], 10000, 40,
9219                         nodes[0].logger).unwrap();
9220
9221         let test_preimage = PaymentPreimage([42; 32]);
9222         let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9223         check_added_monitors!(nodes[0], 1);
9224         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9225         assert_eq!(events.len(), 1);
9226         let event = events.pop().unwrap();
9227         let path = vec![&nodes[1]];
9228         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9229         claim_payment(&nodes[0], &path, test_preimage);
9230 }
9231
9232 #[test]
9233 fn test_keysend_payments_to_private_node() {
9234         let chanmon_cfgs = create_chanmon_cfgs(2);
9235         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9236         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9237         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9238
9239         let payer_pubkey = nodes[0].node.get_our_node_id();
9240         let payee_pubkey = nodes[1].node.get_our_node_id();
9241         nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
9242         nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
9243
9244         let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
9245         let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
9246         let first_hops = nodes[0].node.list_usable_channels();
9247         let route = get_keysend_route(&payer_pubkey, &network_graph, &payee_pubkey,
9248                                 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
9249                                 nodes[0].logger).unwrap();
9250
9251         let test_preimage = PaymentPreimage([42; 32]);
9252         let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage)).unwrap();
9253         check_added_monitors!(nodes[0], 1);
9254         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9255         assert_eq!(events.len(), 1);
9256         let event = events.pop().unwrap();
9257         let path = vec![&nodes[1]];
9258         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9259         claim_payment(&nodes[0], &path, test_preimage);
9260 }
9261
9262 fn do_test_max_dust_htlc_exposure(dust_outbound_balance: bool, at_forward: bool, on_holder_tx: bool) {
9263         // Test that we properly reject dust HTLC violating our `max_dust_htlc_exposure_msat` policy.
9264         //
9265         // At HTLC forward (`send_payment()`), if the sum of the trimmed-to-dust HTLC inbound and
9266         // trimmed-to-dust HTLC outbound balance and this new payment as included on next counterparty
9267         // commitment are above our `max_dust_htlc_exposure_msat`, we'll reject the update.
9268         // At HTLC reception (`update_add_htlc()`), if the sum of the trimmed-to-dust HTLC inbound
9269         // and trimmed-to-dust HTLC outbound balance and this new received HTLC as included on next
9270         // counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll fail the update.
9271         // Note, we return a `temporary_channel_failure` (0x1000 | 7), as the channel might be
9272         // available again for HTLC processing once the dust bandwidth has cleared up.
9273
9274         let chanmon_cfgs = create_chanmon_cfgs(2);
9275         let mut config = test_default_channel_config();
9276         config.channel_options.max_dust_htlc_exposure_msat = 5_000_000; // default setting value
9277         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9278         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(config)]);
9279         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9280
9281         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9282         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9283         open_channel.max_htlc_value_in_flight_msat = 50_000_000;
9284         open_channel.max_accepted_htlcs = 60;
9285         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
9286         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9287         if on_holder_tx {
9288                 accept_channel.dust_limit_satoshis = 660;
9289         }
9290         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
9291
9292         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 1_000_000, 42);
9293
9294         if on_holder_tx {
9295                 if let Some(mut chan) = nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&temporary_channel_id) {
9296                         chan.holder_dust_limit_satoshis = 660;
9297                 }
9298         }
9299
9300         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
9301         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()));
9302         check_added_monitors!(nodes[1], 1);
9303
9304         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()));
9305         check_added_monitors!(nodes[0], 1);
9306
9307         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9308         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
9309         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9310
9311         if on_holder_tx {
9312                 if dust_outbound_balance {
9313                         for i in 0..2 {
9314                                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 2_300_000);
9315                                 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9316                         }
9317                 } else {
9318                         for _ in 0..2 {
9319                                 route_payment(&nodes[0], &[&nodes[1]], 2_300_000);
9320                         }
9321                 }
9322         } else {
9323                 if dust_outbound_balance {
9324                         for i in 0..25 {
9325                                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 200_000); // + 177_000 msat of HTLC-success tx at 253 sats/kWU
9326                                 if let Err(_) = nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)) { panic!("Unexpected event at dust HTLC {}", i); }
9327                         }
9328                 } else {
9329                         for _ in 0..25 {
9330                                 route_payment(&nodes[0], &[&nodes[1]], 200_000); // + 167_000 msat of HTLC-timeout tx at 253 sats/kWU
9331                         }
9332                 }
9333         }
9334
9335         if at_forward {
9336                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], if on_holder_tx { 2_300_000 } else { 200_000 });
9337                 let mut config = UserConfig::default();
9338                 if on_holder_tx {
9339                         unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable { ref err }, assert_eq!(err, &format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx", 6_900_000, config.channel_options.max_dust_htlc_exposure_msat)));
9340                 } else {
9341                         unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable { ref err }, assert_eq!(err, &format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx", 5_200_000, config.channel_options.max_dust_htlc_exposure_msat)));
9342                 }
9343         } else {
9344                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1 ], if on_holder_tx { 2_300_000 } else { 200_000 });
9345                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
9346                 check_added_monitors!(nodes[0], 1);
9347                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9348                 assert_eq!(events.len(), 1);
9349                 let payment_event = SendEvent::from_event(events.remove(0));
9350                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9351                 if on_holder_tx {
9352                         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), format!("Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx", 6_900_000, config.channel_options.max_dust_htlc_exposure_msat), 1);
9353                 } else {
9354                         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), format!("Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx", 5_200_000, config.channel_options.max_dust_htlc_exposure_msat), 1);
9355                 }
9356         }
9357
9358         let _ = nodes[1].node.get_and_clear_pending_msg_events();
9359         let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
9360         added_monitors.clear();
9361 }
9362
9363 #[test]
9364 fn test_max_dust_htlc_exposure() {
9365         do_test_max_dust_htlc_exposure(true, true, true);
9366         do_test_max_dust_htlc_exposure(false, true, true);
9367         do_test_max_dust_htlc_exposure(false, false, true);
9368         do_test_max_dust_htlc_exposure(false, false, false);
9369         do_test_max_dust_htlc_exposure(true, true, false);
9370         do_test_max_dust_htlc_exposure(true, false, false);
9371         do_test_max_dust_htlc_exposure(true, false, true);
9372         do_test_max_dust_htlc_exposure(false, true, false);
9373 }