33eec98c046aea0f6026d530c6ac0c957dd9a817
[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 crate::chain;
15 use crate::chain::{ChannelMonitorUpdateStatus, Confirm, Listen, Watch};
16 use crate::chain::chaininterface::LowerBoundedFeeEstimator;
17 use crate::chain::channelmonitor;
18 use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
19 use crate::chain::transaction::OutPoint;
20 use crate::chain::keysinterface::{BaseSign, KeysInterface};
21 use crate::ln::{PaymentPreimage, PaymentSecret, PaymentHash};
22 use crate::ln::channel::{commitment_tx_base_weight, COMMITMENT_TX_WEIGHT_PER_HTLC, CONCURRENT_INBOUND_HTLC_FEE_BUFFER, FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE, MIN_AFFORDABLE_HTLC_COUNT};
23 use crate::ln::channelmanager::{self, PaymentId, RAACommitmentOrder, PaymentSendFailure, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
24 use crate::ln::channel::{Channel, ChannelError};
25 use crate::ln::{chan_utils, onion_utils};
26 use crate::ln::chan_utils::{OFFERED_HTLC_SCRIPT_WEIGHT, htlc_success_tx_weight, htlc_timeout_tx_weight, HTLCOutputInCommitment};
27 use crate::routing::gossip::{NetworkGraph, NetworkUpdate};
28 use crate::routing::router::{PaymentParameters, Route, RouteHop, RouteParameters, find_route, get_route};
29 use crate::ln::features::{ChannelFeatures, NodeFeatures};
30 use crate::ln::msgs;
31 use crate::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler, ErrorAction};
32 use crate::util::enforcing_trait_impls::EnforcingSigner;
33 use crate::util::{byte_utils, test_utils};
34 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose, ClosureReason, HTLCDestination};
35 use crate::util::errors::APIError;
36 use crate::util::ser::{Writeable, ReadableArgs};
37 use crate::util::config::UserConfig;
38
39 use bitcoin::hash_types::BlockHash;
40 use bitcoin::blockdata::block::{Block, BlockHeader};
41 use bitcoin::blockdata::script::{Builder, Script};
42 use bitcoin::blockdata::opcodes;
43 use bitcoin::blockdata::constants::genesis_block;
44 use bitcoin::network::constants::Network;
45 use bitcoin::{PackedLockTime, Sequence, Transaction, TxIn, TxMerkleNode, TxOut, Witness};
46 use bitcoin::OutPoint as BitcoinOutPoint;
47
48 use bitcoin::secp256k1::Secp256k1;
49 use bitcoin::secp256k1::{PublicKey,SecretKey};
50
51 use regex;
52
53 use crate::io;
54 use crate::prelude::*;
55 use alloc::collections::BTreeSet;
56 use core::default::Default;
57 use core::iter::repeat;
58 use bitcoin::hashes::Hash;
59 use crate::sync::Mutex;
60
61 use crate::ln::functional_test_utils::*;
62 use crate::ln::chan_utils::CommitmentTransaction;
63
64 #[test]
65 fn test_insane_channel_opens() {
66         // Stand up a network of 2 nodes
67         use crate::ln::channel::TOTAL_BITCOIN_SUPPLY_SATOSHIS;
68         let mut cfg = UserConfig::default();
69         cfg.channel_handshake_limits.max_funding_satoshis = TOTAL_BITCOIN_SUPPLY_SATOSHIS + 1;
70         let chanmon_cfgs = create_chanmon_cfgs(2);
71         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
72         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(cfg)]);
73         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
74
75         // Instantiate channel parameters where we push the maximum msats given our
76         // funding satoshis
77         let channel_value_sat = 31337; // same as funding satoshis
78         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat, &cfg);
79         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
80
81         // Have node0 initiate a channel to node1 with aforementioned parameters
82         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
83
84         // Extract the channel open message from node0 to node1
85         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
86
87         // Test helper that asserts we get the correct error string given a mutator
88         // that supposedly makes the channel open message insane
89         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
90                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &message_mutator(open_channel_message.clone()));
91                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
92                 assert_eq!(msg_events.len(), 1);
93                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
94                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
95                         match action {
96                                 &ErrorAction::SendErrorMessage { .. } => {
97                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
98                                 },
99                                 _ => panic!("unexpected event!"),
100                         }
101                 } else { assert!(false); }
102         };
103
104         use crate::ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
105
106         // Test all mutations that would make the channel open message insane
107         insane_open_helper(format!("Per our config, funding must be at most {}. It was {}", TOTAL_BITCOIN_SUPPLY_SATOSHIS + 1, TOTAL_BITCOIN_SUPPLY_SATOSHIS + 2).as_str(), |mut msg| { msg.funding_satoshis = TOTAL_BITCOIN_SUPPLY_SATOSHIS + 2; msg });
108         insane_open_helper(format!("Funding must be smaller than the total bitcoin supply. It was {}", TOTAL_BITCOIN_SUPPLY_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = TOTAL_BITCOIN_SUPPLY_SATOSHIS; msg });
109
110         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
111
112         insane_open_helper(r"push_msat \d+ was larger than channel amount minus reserve \(\d+\)", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
113
114         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
115
116         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 });
117
118         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 });
119
120         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
121
122         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
123 }
124
125 #[test]
126 fn test_funding_exceeds_no_wumbo_limit() {
127         // Test that if a peer does not support wumbo channels, we'll refuse to open a wumbo channel to
128         // them.
129         use crate::ln::channel::MAX_FUNDING_SATOSHIS_NO_WUMBO;
130         let chanmon_cfgs = create_chanmon_cfgs(2);
131         let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
132         node_cfgs[1].features = channelmanager::provided_init_features().clear_wumbo();
133         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
134         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
135
136         match nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), MAX_FUNDING_SATOSHIS_NO_WUMBO + 1, 0, 42, None) {
137                 Err(APIError::APIMisuseError { err }) => {
138                         assert_eq!(format!("funding_value must not exceed {}, it was {}", MAX_FUNDING_SATOSHIS_NO_WUMBO, MAX_FUNDING_SATOSHIS_NO_WUMBO + 1), err);
139                 },
140                 _ => panic!()
141         }
142 }
143
144 fn do_test_counterparty_no_reserve(send_from_initiator: bool) {
145         // A peer providing a channel_reserve_satoshis of 0 (or less than our dust limit) is insecure,
146         // but only for them. Because some LSPs do it with some level of trust of the clients (for a
147         // substantial UX improvement), we explicitly allow it. Because it's unlikely to happen often
148         // in normal testing, we test it explicitly here.
149         let chanmon_cfgs = create_chanmon_cfgs(2);
150         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
151         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
152         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
153         let default_config = UserConfig::default();
154
155         // Have node0 initiate a channel to node1 with aforementioned parameters
156         let mut push_amt = 100_000_000;
157         let feerate_per_kw = 253;
158         let opt_anchors = false;
159         push_amt -= feerate_per_kw as u64 * (commitment_tx_base_weight(opt_anchors) + 4 * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000 * 1000;
160         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
161
162         let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, if send_from_initiator { 0 } else { push_amt }, 42, None).unwrap();
163         let mut open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
164         if !send_from_initiator {
165                 open_channel_message.channel_reserve_satoshis = 0;
166                 open_channel_message.max_htlc_value_in_flight_msat = 100_000_000;
167         }
168         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel_message);
169
170         // Extract the channel accept message from node1 to node0
171         let mut accept_channel_message = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
172         if send_from_initiator {
173                 accept_channel_message.channel_reserve_satoshis = 0;
174                 accept_channel_message.max_htlc_value_in_flight_msat = 100_000_000;
175         }
176         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel_message);
177         {
178                 let mut lock;
179                 let mut chan = get_channel_ref!(if send_from_initiator { &nodes[1] } else { &nodes[0] }, lock, temp_channel_id);
180                 chan.holder_selected_channel_reserve_satoshis = 0;
181                 chan.holder_max_htlc_value_in_flight_msat = 100_000_000;
182         }
183
184         let funding_tx = sign_funding_transaction(&nodes[0], &nodes[1], 100_000, temp_channel_id);
185         let funding_msgs = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &funding_tx);
186         create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_msgs.0);
187
188         // nodes[0] should now be able to send the full balance to nodes[1], violating nodes[1]'s
189         // security model if it ever tries to send funds back to nodes[0] (but that's not our problem).
190         if send_from_initiator {
191                 send_payment(&nodes[0], &[&nodes[1]], 100_000_000
192                         // Note that for outbound channels we have to consider the commitment tx fee and the
193                         // "fee spike buffer", which is currently a multiple of the total commitment tx fee as
194                         // well as an additional HTLC.
195                         - FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE * commit_tx_fee_msat(feerate_per_kw, 2, opt_anchors));
196         } else {
197                 send_payment(&nodes[1], &[&nodes[0]], push_amt);
198         }
199 }
200
201 #[test]
202 fn test_counterparty_no_reserve() {
203         do_test_counterparty_no_reserve(true);
204         do_test_counterparty_no_reserve(false);
205 }
206
207 #[test]
208 fn test_async_inbound_update_fee() {
209         let chanmon_cfgs = create_chanmon_cfgs(2);
210         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
211         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
212         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
213         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
214
215         // balancing
216         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
217
218         // A                                        B
219         // update_fee                            ->
220         // send (1) commitment_signed            -.
221         //                                       <- update_add_htlc/commitment_signed
222         // send (2) RAA (awaiting remote revoke) -.
223         // (1) commitment_signed is delivered    ->
224         //                                       .- send (3) RAA (awaiting remote revoke)
225         // (2) RAA is delivered                  ->
226         //                                       .- send (4) commitment_signed
227         //                                       <- (3) RAA is delivered
228         // send (5) commitment_signed            -.
229         //                                       <- (4) commitment_signed is delivered
230         // send (6) RAA                          -.
231         // (5) commitment_signed is delivered    ->
232         //                                       <- RAA
233         // (6) RAA is delivered                  ->
234
235         // First nodes[0] generates an update_fee
236         {
237                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
238                 *feerate_lock += 20;
239         }
240         nodes[0].node.timer_tick_occurred();
241         check_added_monitors!(nodes[0], 1);
242
243         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
244         assert_eq!(events_0.len(), 1);
245         let (update_msg, commitment_signed) = match events_0[0] { // (1)
246                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
247                         (update_fee.as_ref(), commitment_signed)
248                 },
249                 _ => panic!("Unexpected event"),
250         };
251
252         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
253
254         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
255         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 40000);
256         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
257         check_added_monitors!(nodes[1], 1);
258
259         let payment_event = {
260                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
261                 assert_eq!(events_1.len(), 1);
262                 SendEvent::from_event(events_1.remove(0))
263         };
264         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
265         assert_eq!(payment_event.msgs.len(), 1);
266
267         // ...now when the messages get delivered everyone should be happy
268         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
269         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
270         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
271         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
272         check_added_monitors!(nodes[0], 1);
273
274         // deliver(1), generate (3):
275         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
276         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
277         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
278         check_added_monitors!(nodes[1], 1);
279
280         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
281         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
282         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
283         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
284         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
285         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
286         assert!(bs_update.update_fee.is_none()); // (4)
287         check_added_monitors!(nodes[1], 1);
288
289         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
290         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
291         assert!(as_update.update_add_htlcs.is_empty()); // (5)
292         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
293         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
294         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
295         assert!(as_update.update_fee.is_none()); // (5)
296         check_added_monitors!(nodes[0], 1);
297
298         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
299         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
300         // only (6) so get_event_msg's assert(len == 1) passes
301         check_added_monitors!(nodes[0], 1);
302
303         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
304         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
305         check_added_monitors!(nodes[1], 1);
306
307         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
308         check_added_monitors!(nodes[0], 1);
309
310         let events_2 = nodes[0].node.get_and_clear_pending_events();
311         assert_eq!(events_2.len(), 1);
312         match events_2[0] {
313                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
314                 _ => panic!("Unexpected event"),
315         }
316
317         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
318         check_added_monitors!(nodes[1], 1);
319 }
320
321 #[test]
322 fn test_update_fee_unordered_raa() {
323         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
324         // crash in an earlier version of the update_fee patch)
325         let chanmon_cfgs = create_chanmon_cfgs(2);
326         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
327         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
328         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
329         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
330
331         // balancing
332         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
333
334         // First nodes[0] generates an update_fee
335         {
336                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
337                 *feerate_lock += 20;
338         }
339         nodes[0].node.timer_tick_occurred();
340         check_added_monitors!(nodes[0], 1);
341
342         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
343         assert_eq!(events_0.len(), 1);
344         let update_msg = match events_0[0] { // (1)
345                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
346                         update_fee.as_ref()
347                 },
348                 _ => panic!("Unexpected event"),
349         };
350
351         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
352
353         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
354         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 40000);
355         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
356         check_added_monitors!(nodes[1], 1);
357
358         let payment_event = {
359                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
360                 assert_eq!(events_1.len(), 1);
361                 SendEvent::from_event(events_1.remove(0))
362         };
363         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
364         assert_eq!(payment_event.msgs.len(), 1);
365
366         // ...now when the messages get delivered everyone should be happy
367         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
368         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
369         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
370         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
371         check_added_monitors!(nodes[0], 1);
372
373         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
374         check_added_monitors!(nodes[1], 1);
375
376         // We can't continue, sadly, because our (1) now has a bogus signature
377 }
378
379 #[test]
380 fn test_multi_flight_update_fee() {
381         let chanmon_cfgs = create_chanmon_cfgs(2);
382         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
383         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
384         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
385         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
386
387         // A                                        B
388         // update_fee/commitment_signed          ->
389         //                                       .- send (1) RAA and (2) commitment_signed
390         // update_fee (never committed)          ->
391         // (3) update_fee                        ->
392         // We have to manually generate the above update_fee, it is allowed by the protocol but we
393         // don't track which updates correspond to which revoke_and_ack responses so we're in
394         // AwaitingRAA mode and will not generate the update_fee yet.
395         //                                       <- (1) RAA delivered
396         // (3) is generated and send (4) CS      -.
397         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
398         // know the per_commitment_point to use for it.
399         //                                       <- (2) commitment_signed delivered
400         // revoke_and_ack                        ->
401         //                                          B should send no response here
402         // (4) commitment_signed delivered       ->
403         //                                       <- RAA/commitment_signed delivered
404         // revoke_and_ack                        ->
405
406         // First nodes[0] generates an update_fee
407         let initial_feerate;
408         {
409                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
410                 initial_feerate = *feerate_lock;
411                 *feerate_lock = initial_feerate + 20;
412         }
413         nodes[0].node.timer_tick_occurred();
414         check_added_monitors!(nodes[0], 1);
415
416         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
417         assert_eq!(events_0.len(), 1);
418         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
419                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
420                         (update_fee.as_ref().unwrap(), commitment_signed)
421                 },
422                 _ => panic!("Unexpected event"),
423         };
424
425         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
426         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
427         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
428         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
429         check_added_monitors!(nodes[1], 1);
430
431         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
432         // transaction:
433         {
434                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
435                 *feerate_lock = initial_feerate + 40;
436         }
437         nodes[0].node.timer_tick_occurred();
438         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
439         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
440
441         // Create the (3) update_fee message that nodes[0] will generate before it does...
442         let mut update_msg_2 = msgs::UpdateFee {
443                 channel_id: update_msg_1.channel_id.clone(),
444                 feerate_per_kw: (initial_feerate + 30) as u32,
445         };
446
447         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
448
449         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
450         // Deliver (3)
451         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
452
453         // Deliver (1), generating (3) and (4)
454         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
455         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
456         check_added_monitors!(nodes[0], 1);
457         assert!(as_second_update.update_add_htlcs.is_empty());
458         assert!(as_second_update.update_fulfill_htlcs.is_empty());
459         assert!(as_second_update.update_fail_htlcs.is_empty());
460         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
461         // Check that the update_fee newly generated matches what we delivered:
462         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
463         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
464
465         // Deliver (2) commitment_signed
466         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
467         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
468         check_added_monitors!(nodes[0], 1);
469         // No commitment_signed so get_event_msg's assert(len == 1) passes
470
471         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
472         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
473         check_added_monitors!(nodes[1], 1);
474
475         // Delever (4)
476         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
477         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
478         check_added_monitors!(nodes[1], 1);
479
480         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
481         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
482         check_added_monitors!(nodes[0], 1);
483
484         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
485         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
486         // No commitment_signed so get_event_msg's assert(len == 1) passes
487         check_added_monitors!(nodes[0], 1);
488
489         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
490         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
491         check_added_monitors!(nodes[1], 1);
492 }
493
494 fn do_test_sanity_on_in_flight_opens(steps: u8) {
495         // Previously, we had issues deserializing channels when we hadn't connected the first block
496         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
497         // serialization round-trips and simply do steps towards opening a channel and then drop the
498         // Node objects.
499
500         let chanmon_cfgs = create_chanmon_cfgs(2);
501         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
502         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
503         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
504
505         if steps & 0b1000_0000 != 0{
506                 let block = Block {
507                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
508                         txdata: vec![],
509                 };
510                 connect_block(&nodes[0], &block);
511                 connect_block(&nodes[1], &block);
512         }
513
514         if steps & 0x0f == 0 { return; }
515         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
516         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
517
518         if steps & 0x0f == 1 { return; }
519         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
520         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
521
522         if steps & 0x0f == 2 { return; }
523         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
524
525         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
526
527         if steps & 0x0f == 3 { return; }
528         nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
529         check_added_monitors!(nodes[0], 0);
530         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
531
532         if steps & 0x0f == 4 { return; }
533         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
534         {
535                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
536                 assert_eq!(added_monitors.len(), 1);
537                 assert_eq!(added_monitors[0].0, funding_output);
538                 added_monitors.clear();
539         }
540         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
541
542         if steps & 0x0f == 5 { return; }
543         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
544         {
545                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
546                 assert_eq!(added_monitors.len(), 1);
547                 assert_eq!(added_monitors[0].0, funding_output);
548                 added_monitors.clear();
549         }
550
551         let events_4 = nodes[0].node.get_and_clear_pending_events();
552         assert_eq!(events_4.len(), 0);
553
554         if steps & 0x0f == 6 { return; }
555         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
556
557         if steps & 0x0f == 7 { return; }
558         confirm_transaction_at(&nodes[0], &tx, 2);
559         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
560         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
561         expect_channel_ready_event(&nodes[0], &nodes[1].node.get_our_node_id());
562 }
563
564 #[test]
565 fn test_sanity_on_in_flight_opens() {
566         do_test_sanity_on_in_flight_opens(0);
567         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
568         do_test_sanity_on_in_flight_opens(1);
569         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
570         do_test_sanity_on_in_flight_opens(2);
571         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
572         do_test_sanity_on_in_flight_opens(3);
573         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
574         do_test_sanity_on_in_flight_opens(4);
575         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
576         do_test_sanity_on_in_flight_opens(5);
577         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
578         do_test_sanity_on_in_flight_opens(6);
579         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
580         do_test_sanity_on_in_flight_opens(7);
581         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
582         do_test_sanity_on_in_flight_opens(8);
583         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
584 }
585
586 #[test]
587 fn test_update_fee_vanilla() {
588         let chanmon_cfgs = create_chanmon_cfgs(2);
589         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
590         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
591         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
592         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
593
594         {
595                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
596                 *feerate_lock += 25;
597         }
598         nodes[0].node.timer_tick_occurred();
599         check_added_monitors!(nodes[0], 1);
600
601         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
602         assert_eq!(events_0.len(), 1);
603         let (update_msg, commitment_signed) = match events_0[0] {
604                         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 } } => {
605                         (update_fee.as_ref(), commitment_signed)
606                 },
607                 _ => panic!("Unexpected event"),
608         };
609         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
610
611         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
612         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
613         check_added_monitors!(nodes[1], 1);
614
615         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
616         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
617         check_added_monitors!(nodes[0], 1);
618
619         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
620         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
621         // No commitment_signed so get_event_msg's assert(len == 1) passes
622         check_added_monitors!(nodes[0], 1);
623
624         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
625         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
626         check_added_monitors!(nodes[1], 1);
627 }
628
629 #[test]
630 fn test_update_fee_that_funder_cannot_afford() {
631         let chanmon_cfgs = create_chanmon_cfgs(2);
632         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
633         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
634         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
635         let channel_value = 5000;
636         let push_sats = 700;
637         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, push_sats * 1000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
638         let channel_id = chan.2;
639         let secp_ctx = Secp256k1::new();
640         let default_config = UserConfig::default();
641         let bs_channel_reserve_sats = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value, &default_config);
642
643         let opt_anchors = false;
644
645         // Calculate the maximum feerate that A can afford. Note that we don't send an update_fee
646         // CONCURRENT_INBOUND_HTLC_FEE_BUFFER HTLCs before actually running out of local balance, so we
647         // calculate two different feerates here - the expected local limit as well as the expected
648         // remote limit.
649         let feerate = ((channel_value - bs_channel_reserve_sats - push_sats) * 1000 / (commitment_tx_base_weight(opt_anchors) + CONCURRENT_INBOUND_HTLC_FEE_BUFFER as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC)) as u32;
650         let non_buffer_feerate = ((channel_value - bs_channel_reserve_sats - push_sats) * 1000 / commitment_tx_base_weight(opt_anchors)) as u32;
651         {
652                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
653                 *feerate_lock = feerate;
654         }
655         nodes[0].node.timer_tick_occurred();
656         check_added_monitors!(nodes[0], 1);
657         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
658
659         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
660
661         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
662
663         // Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate set above.
664         {
665                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
666
667                 //We made sure neither party's funds are below the dust limit and there are no HTLCs here
668                 assert_eq!(commitment_tx.output.len(), 2);
669                 let total_fee: u64 = commit_tx_fee_msat(feerate, 0, opt_anchors) / 1000;
670                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
671                 actual_fee = channel_value - actual_fee;
672                 assert_eq!(total_fee, actual_fee);
673         }
674
675         {
676                 // Increment the feerate by a small constant, accounting for rounding errors
677                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
678                 *feerate_lock += 4;
679         }
680         nodes[0].node.timer_tick_occurred();
681         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), format!("Cannot afford to send new feerate at {}", feerate + 4), 1);
682         check_added_monitors!(nodes[0], 0);
683
684         const INITIAL_COMMITMENT_NUMBER: u64 = 281474976710654;
685
686         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
687         // needed to sign the new commitment tx and (2) sign the new commitment tx.
688         let (local_revocation_basepoint, local_htlc_basepoint, local_funding) = {
689                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
690                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
691                 let chan_signer = local_chan.get_signer();
692                 let pubkeys = chan_signer.pubkeys();
693                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
694                  pubkeys.funding_pubkey)
695         };
696         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point, remote_funding) = {
697                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
698                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
699                 let chan_signer = remote_chan.get_signer();
700                 let pubkeys = chan_signer.pubkeys();
701                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
702                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
703                  pubkeys.funding_pubkey)
704         };
705
706         // Assemble the set of keys we can use for signatures for our commitment_signed message.
707         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
708                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
709
710         let res = {
711                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
712                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
713                 let local_chan_signer = local_chan.get_signer();
714                 let mut htlcs: Vec<(HTLCOutputInCommitment, ())> = vec![];
715                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
716                         INITIAL_COMMITMENT_NUMBER - 1,
717                         push_sats,
718                         channel_value - push_sats - commit_tx_fee_msat(non_buffer_feerate + 4, 0, opt_anchors) / 1000,
719                         opt_anchors, local_funding, remote_funding,
720                         commit_tx_keys.clone(),
721                         non_buffer_feerate + 4,
722                         &mut htlcs,
723                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
724                 );
725                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, Vec::new(), &secp_ctx).unwrap()
726         };
727
728         let commit_signed_msg = msgs::CommitmentSigned {
729                 channel_id: chan.2,
730                 signature: res.0,
731                 htlc_signatures: res.1
732         };
733
734         let update_fee = msgs::UpdateFee {
735                 channel_id: chan.2,
736                 feerate_per_kw: non_buffer_feerate + 4,
737         };
738
739         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_fee);
740
741         //While producing the commitment_signed response after handling a received update_fee request the
742         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
743         //Should produce and error.
744         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
745         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
746         check_added_monitors!(nodes[1], 1);
747         check_closed_broadcast!(nodes[1], true);
748         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: String::from("Funding remote cannot afford proposed new fee") });
749 }
750
751 #[test]
752 fn test_update_fee_with_fundee_update_add_htlc() {
753         let chanmon_cfgs = create_chanmon_cfgs(2);
754         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
755         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
756         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
757         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
758
759         // balancing
760         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
761
762         {
763                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
764                 *feerate_lock += 20;
765         }
766         nodes[0].node.timer_tick_occurred();
767         check_added_monitors!(nodes[0], 1);
768
769         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
770         assert_eq!(events_0.len(), 1);
771         let (update_msg, commitment_signed) = match events_0[0] {
772                         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 } } => {
773                         (update_fee.as_ref(), commitment_signed)
774                 },
775                 _ => panic!("Unexpected event"),
776         };
777         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
778         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
779         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
780         check_added_monitors!(nodes[1], 1);
781
782         let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 800000);
783
784         // nothing happens since node[1] is in AwaitingRemoteRevoke
785         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
786         {
787                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
788                 assert_eq!(added_monitors.len(), 0);
789                 added_monitors.clear();
790         }
791         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
792         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
793         // node[1] has nothing to do
794
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         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
800         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
801         // No commitment_signed so get_event_msg's assert(len == 1) passes
802         check_added_monitors!(nodes[0], 1);
803         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
804         check_added_monitors!(nodes[1], 1);
805         // AwaitingRemoteRevoke ends here
806
807         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
808         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
809         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
810         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
811         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
812         assert_eq!(commitment_update.update_fee.is_none(), true);
813
814         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
815         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
816         check_added_monitors!(nodes[0], 1);
817         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
818
819         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
820         check_added_monitors!(nodes[1], 1);
821         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
822
823         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
824         check_added_monitors!(nodes[1], 1);
825         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
826         // No commitment_signed so get_event_msg's assert(len == 1) passes
827
828         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
829         check_added_monitors!(nodes[0], 1);
830         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
831
832         expect_pending_htlcs_forwardable!(nodes[0]);
833
834         let events = nodes[0].node.get_and_clear_pending_events();
835         assert_eq!(events.len(), 1);
836         match events[0] {
837                 Event::PaymentReceived { .. } => { },
838                 _ => panic!("Unexpected event"),
839         };
840
841         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
842
843         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
844         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
845         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
846         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
847         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
848 }
849
850 #[test]
851 fn test_update_fee() {
852         let chanmon_cfgs = create_chanmon_cfgs(2);
853         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
854         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
855         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
856         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
857         let channel_id = chan.2;
858
859         // A                                        B
860         // (1) update_fee/commitment_signed      ->
861         //                                       <- (2) revoke_and_ack
862         //                                       .- send (3) commitment_signed
863         // (4) update_fee/commitment_signed      ->
864         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
865         //                                       <- (3) commitment_signed delivered
866         // send (6) revoke_and_ack               -.
867         //                                       <- (5) deliver revoke_and_ack
868         // (6) deliver revoke_and_ack            ->
869         //                                       .- send (7) commitment_signed in response to (4)
870         //                                       <- (7) deliver commitment_signed
871         // revoke_and_ack                        ->
872
873         // Create and deliver (1)...
874         let feerate;
875         {
876                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
877                 feerate = *feerate_lock;
878                 *feerate_lock = feerate + 20;
879         }
880         nodes[0].node.timer_tick_occurred();
881         check_added_monitors!(nodes[0], 1);
882
883         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
884         assert_eq!(events_0.len(), 1);
885         let (update_msg, commitment_signed) = match events_0[0] {
886                         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 } } => {
887                         (update_fee.as_ref(), commitment_signed)
888                 },
889                 _ => panic!("Unexpected event"),
890         };
891         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
892
893         // Generate (2) and (3):
894         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
895         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
896         check_added_monitors!(nodes[1], 1);
897
898         // Deliver (2):
899         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
900         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
901         check_added_monitors!(nodes[0], 1);
902
903         // Create and deliver (4)...
904         {
905                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
906                 *feerate_lock = feerate + 30;
907         }
908         nodes[0].node.timer_tick_occurred();
909         check_added_monitors!(nodes[0], 1);
910         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
911         assert_eq!(events_0.len(), 1);
912         let (update_msg, commitment_signed) = match events_0[0] {
913                         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 } } => {
914                         (update_fee.as_ref(), commitment_signed)
915                 },
916                 _ => panic!("Unexpected event"),
917         };
918
919         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
920         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
921         check_added_monitors!(nodes[1], 1);
922         // ... creating (5)
923         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
924         // No commitment_signed so get_event_msg's assert(len == 1) passes
925
926         // Handle (3), creating (6):
927         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
928         check_added_monitors!(nodes[0], 1);
929         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
930         // No commitment_signed so get_event_msg's assert(len == 1) passes
931
932         // Deliver (5):
933         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
934         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
935         check_added_monitors!(nodes[0], 1);
936
937         // Deliver (6), creating (7):
938         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
939         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
940         assert!(commitment_update.update_add_htlcs.is_empty());
941         assert!(commitment_update.update_fulfill_htlcs.is_empty());
942         assert!(commitment_update.update_fail_htlcs.is_empty());
943         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
944         assert!(commitment_update.update_fee.is_none());
945         check_added_monitors!(nodes[1], 1);
946
947         // Deliver (7)
948         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
949         check_added_monitors!(nodes[0], 1);
950         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
951         // No commitment_signed so get_event_msg's assert(len == 1) passes
952
953         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
954         check_added_monitors!(nodes[1], 1);
955         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
956
957         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
958         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
959         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
960         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
961         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
962 }
963
964 #[test]
965 fn fake_network_test() {
966         // Simple test which builds a network of ChannelManagers, connects them to each other, and
967         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
968         let chanmon_cfgs = create_chanmon_cfgs(4);
969         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
970         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
971         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
972
973         // Create some initial channels
974         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
975         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
976         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features());
977
978         // Rebalance the network a bit by relaying one payment through all the channels...
979         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
980         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
981         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
982         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
983
984         // Send some more payments
985         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
986         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
987         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
988
989         // Test failure packets
990         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
991         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
992
993         // Add a new channel that skips 3
994         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features());
995
996         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
997         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
998         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
999         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1000         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1001         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1002         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1003
1004         // Do some rebalance loop payments, simultaneously
1005         let mut hops = Vec::with_capacity(3);
1006         hops.push(RouteHop {
1007                 pubkey: nodes[2].node.get_our_node_id(),
1008                 node_features: NodeFeatures::empty(),
1009                 short_channel_id: chan_2.0.contents.short_channel_id,
1010                 channel_features: ChannelFeatures::empty(),
1011                 fee_msat: 0,
1012                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1013         });
1014         hops.push(RouteHop {
1015                 pubkey: nodes[3].node.get_our_node_id(),
1016                 node_features: NodeFeatures::empty(),
1017                 short_channel_id: chan_3.0.contents.short_channel_id,
1018                 channel_features: ChannelFeatures::empty(),
1019                 fee_msat: 0,
1020                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1021         });
1022         hops.push(RouteHop {
1023                 pubkey: nodes[1].node.get_our_node_id(),
1024                 node_features: channelmanager::provided_node_features(),
1025                 short_channel_id: chan_4.0.contents.short_channel_id,
1026                 channel_features: channelmanager::provided_channel_features(),
1027                 fee_msat: 1000000,
1028                 cltv_expiry_delta: TEST_FINAL_CLTV,
1029         });
1030         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;
1031         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;
1032         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops], payment_params: None }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1033
1034         let mut hops = Vec::with_capacity(3);
1035         hops.push(RouteHop {
1036                 pubkey: nodes[3].node.get_our_node_id(),
1037                 node_features: NodeFeatures::empty(),
1038                 short_channel_id: chan_4.0.contents.short_channel_id,
1039                 channel_features: ChannelFeatures::empty(),
1040                 fee_msat: 0,
1041                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1042         });
1043         hops.push(RouteHop {
1044                 pubkey: nodes[2].node.get_our_node_id(),
1045                 node_features: NodeFeatures::empty(),
1046                 short_channel_id: chan_3.0.contents.short_channel_id,
1047                 channel_features: ChannelFeatures::empty(),
1048                 fee_msat: 0,
1049                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1050         });
1051         hops.push(RouteHop {
1052                 pubkey: nodes[1].node.get_our_node_id(),
1053                 node_features: channelmanager::provided_node_features(),
1054                 short_channel_id: chan_2.0.contents.short_channel_id,
1055                 channel_features: channelmanager::provided_channel_features(),
1056                 fee_msat: 1000000,
1057                 cltv_expiry_delta: TEST_FINAL_CLTV,
1058         });
1059         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;
1060         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;
1061         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops], payment_params: None }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1062
1063         // Claim the rebalances...
1064         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1065         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1066
1067         // Close down the channels...
1068         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1069         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
1070         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1071         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1072         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1073         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
1074         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1075         check_closed_event!(nodes[2], 1, ClosureReason::CooperativeClosure);
1076         check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
1077         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1078         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
1079         check_closed_event!(nodes[3], 1, ClosureReason::CooperativeClosure);
1080 }
1081
1082 #[test]
1083 fn holding_cell_htlc_counting() {
1084         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1085         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1086         // commitment dance rounds.
1087         let chanmon_cfgs = create_chanmon_cfgs(3);
1088         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1089         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1090         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1091         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1092         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1093
1094         let mut payments = Vec::new();
1095         for _ in 0..crate::ln::channel::OUR_MAX_HTLCS {
1096                 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
1097                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1098                 payments.push((payment_preimage, payment_hash));
1099         }
1100         check_added_monitors!(nodes[1], 1);
1101
1102         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1103         assert_eq!(events.len(), 1);
1104         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1105         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1106
1107         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1108         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1109         // another HTLC.
1110         let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
1111         {
1112                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)), true, APIError::ChannelUnavailable { ref err },
1113                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1114                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1115                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1116         }
1117
1118         // This should also be true if we try to forward a payment.
1119         let (route, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
1120         {
1121                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1122                 check_added_monitors!(nodes[0], 1);
1123         }
1124
1125         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1126         assert_eq!(events.len(), 1);
1127         let payment_event = SendEvent::from_event(events.pop().unwrap());
1128         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1129
1130         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1131         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1132         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1133         // fails), the second will process the resulting failure and fail the HTLC backward.
1134         expect_pending_htlcs_forwardable!(nodes[1]);
1135         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
1136         check_added_monitors!(nodes[1], 1);
1137
1138         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1139         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1140         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1141
1142         expect_payment_failed_with_update!(nodes[0], payment_hash_2, false, chan_2.0.contents.short_channel_id, false);
1143
1144         // Now forward all the pending HTLCs and claim them back
1145         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1146         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1147         check_added_monitors!(nodes[2], 1);
1148
1149         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1150         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1151         check_added_monitors!(nodes[1], 1);
1152         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1153
1154         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1155         check_added_monitors!(nodes[1], 1);
1156         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1157
1158         for ref update in as_updates.update_add_htlcs.iter() {
1159                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1160         }
1161         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1162         check_added_monitors!(nodes[2], 1);
1163         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1164         check_added_monitors!(nodes[2], 1);
1165         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1166
1167         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1168         check_added_monitors!(nodes[1], 1);
1169         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1170         check_added_monitors!(nodes[1], 1);
1171         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1172
1173         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1174         check_added_monitors!(nodes[2], 1);
1175
1176         expect_pending_htlcs_forwardable!(nodes[2]);
1177
1178         let events = nodes[2].node.get_and_clear_pending_events();
1179         assert_eq!(events.len(), payments.len());
1180         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1181                 match event {
1182                         &Event::PaymentReceived { ref payment_hash, .. } => {
1183                                 assert_eq!(*payment_hash, *hash);
1184                         },
1185                         _ => panic!("Unexpected event"),
1186                 };
1187         }
1188
1189         for (preimage, _) in payments.drain(..) {
1190                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1191         }
1192
1193         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1194 }
1195
1196 #[test]
1197 fn duplicate_htlc_test() {
1198         // Test that we accept duplicate payment_hash HTLCs across the network and that
1199         // claiming/failing them are all separate and don't affect each other
1200         let chanmon_cfgs = create_chanmon_cfgs(6);
1201         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1202         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1203         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1204
1205         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1206         create_announced_chan_between_nodes(&nodes, 0, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1207         create_announced_chan_between_nodes(&nodes, 1, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1208         create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1209         create_announced_chan_between_nodes(&nodes, 3, 4, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1210         create_announced_chan_between_nodes(&nodes, 3, 5, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1211
1212         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1213
1214         *nodes[0].network_payment_count.borrow_mut() -= 1;
1215         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1216
1217         *nodes[0].network_payment_count.borrow_mut() -= 1;
1218         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1219
1220         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1221         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1222         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1223 }
1224
1225 #[test]
1226 fn test_duplicate_htlc_different_direction_onchain() {
1227         // Test that ChannelMonitor doesn't generate 2 preimage txn
1228         // when we have 2 HTLCs with same preimage that go across a node
1229         // in opposite directions, even with the same payment secret.
1230         let chanmon_cfgs = create_chanmon_cfgs(2);
1231         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1232         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1233         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1234
1235         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1236
1237         // balancing
1238         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1239
1240         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1241
1242         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[0], 800_000);
1243         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200).unwrap();
1244         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1245
1246         // Provide preimage to node 0 by claiming payment
1247         nodes[0].node.claim_funds(payment_preimage);
1248         expect_payment_claimed!(nodes[0], payment_hash, 800_000);
1249         check_added_monitors!(nodes[0], 1);
1250
1251         // Broadcast node 1 commitment txn
1252         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1253
1254         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1255         let mut has_both_htlcs = 0; // check htlcs match ones committed
1256         for outp in remote_txn[0].output.iter() {
1257                 if outp.value == 800_000 / 1000 {
1258                         has_both_htlcs += 1;
1259                 } else if outp.value == 900_000 / 1000 {
1260                         has_both_htlcs += 1;
1261                 }
1262         }
1263         assert_eq!(has_both_htlcs, 2);
1264
1265         mine_transaction(&nodes[0], &remote_txn[0]);
1266         check_added_monitors!(nodes[0], 1);
1267         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
1268         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
1269
1270         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1271         assert_eq!(claim_txn.len(), 5);
1272
1273         check_spends!(claim_txn[0], remote_txn[0]); // Immediate HTLC claim with preimage
1274         check_spends!(claim_txn[1], chan_1.3); // Alternative commitment tx
1275         check_spends!(claim_txn[2], claim_txn[1]); // HTLC spend in alternative commitment tx
1276
1277         check_spends!(claim_txn[3], remote_txn[0]);
1278         check_spends!(claim_txn[4], remote_txn[0]);
1279         let preimage_tx = &claim_txn[0];
1280         let (preimage_bump_tx, timeout_tx) = if claim_txn[3].input[0].previous_output == preimage_tx.input[0].previous_output {
1281                 (&claim_txn[3], &claim_txn[4])
1282         } else {
1283                 (&claim_txn[4], &claim_txn[3])
1284         };
1285
1286         assert_eq!(preimage_tx.input.len(), 1);
1287         assert_eq!(preimage_bump_tx.input.len(), 1);
1288
1289         assert_eq!(preimage_tx.input.len(), 1);
1290         assert_eq!(preimage_tx.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1291         assert_eq!(remote_txn[0].output[preimage_tx.input[0].previous_output.vout as usize].value, 800);
1292
1293         assert_eq!(timeout_tx.input.len(), 1);
1294         assert_eq!(timeout_tx.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1295         check_spends!(timeout_tx, remote_txn[0]);
1296         assert_eq!(remote_txn[0].output[timeout_tx.input[0].previous_output.vout as usize].value, 900);
1297
1298         let events = nodes[0].node.get_and_clear_pending_msg_events();
1299         assert_eq!(events.len(), 3);
1300         for e in events {
1301                 match e {
1302                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1303                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1304                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1305                                 assert_eq!(msg.data, "Channel closed because commitment or closing transaction was confirmed on chain.");
1306                         },
1307                         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, .. } } => {
1308                                 assert!(update_add_htlcs.is_empty());
1309                                 assert!(update_fail_htlcs.is_empty());
1310                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1311                                 assert!(update_fail_malformed_htlcs.is_empty());
1312                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1313                         },
1314                         _ => panic!("Unexpected event"),
1315                 }
1316         }
1317 }
1318
1319 #[test]
1320 fn test_basic_channel_reserve() {
1321         let chanmon_cfgs = create_chanmon_cfgs(2);
1322         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1323         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1324         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1325         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1326
1327         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1328         let channel_reserve = chan_stat.channel_reserve_msat;
1329
1330         // The 2* and +1 are for the fee spike reserve.
1331         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1, get_opt_anchors!(nodes[0], chan.2));
1332         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1333         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send + 1);
1334         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).err().unwrap();
1335         match err {
1336                 PaymentSendFailure::AllFailedResendSafe(ref fails) => {
1337                         match &fails[0] {
1338                                 &APIError::ChannelUnavailable{ref err} =>
1339                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1340                                 _ => panic!("Unexpected error variant"),
1341                         }
1342                 },
1343                 _ => panic!("Unexpected error variant"),
1344         }
1345         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1346         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);
1347
1348         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1349 }
1350
1351 #[test]
1352 fn test_fee_spike_violation_fails_htlc() {
1353         let chanmon_cfgs = create_chanmon_cfgs(2);
1354         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1355         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1356         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1357         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1358
1359         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1360         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1361         let secp_ctx = Secp256k1::new();
1362         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1363
1364         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1365
1366         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1367         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height, &None).unwrap();
1368         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1369         let msg = msgs::UpdateAddHTLC {
1370                 channel_id: chan.2,
1371                 htlc_id: 0,
1372                 amount_msat: htlc_msat,
1373                 payment_hash: payment_hash,
1374                 cltv_expiry: htlc_cltv,
1375                 onion_routing_packet: onion_packet,
1376         };
1377
1378         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1379
1380         // Now manually create the commitment_signed message corresponding to the update_add
1381         // nodes[0] just sent. In the code for construction of this message, "local" refers
1382         // to the sender of the message, and "remote" refers to the receiver.
1383
1384         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1385
1386         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1387
1388         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1389         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1390         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point, local_funding) = {
1391                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1392                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1393                 let chan_signer = local_chan.get_signer();
1394                 // Make the signer believe we validated another commitment, so we can release the secret
1395                 chan_signer.get_enforcement_state().last_holder_commitment -= 1;
1396
1397                 let pubkeys = chan_signer.pubkeys();
1398                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1399                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1400                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx),
1401                  chan_signer.pubkeys().funding_pubkey)
1402         };
1403         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_point, remote_funding) = {
1404                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1405                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1406                 let chan_signer = remote_chan.get_signer();
1407                 let pubkeys = chan_signer.pubkeys();
1408                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1409                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx),
1410                  chan_signer.pubkeys().funding_pubkey)
1411         };
1412
1413         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1414         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1415                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1416
1417         // Build the remote commitment transaction so we can sign it, and then later use the
1418         // signature for the commitment_signed message.
1419         let local_chan_balance = 1313;
1420
1421         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1422                 offered: false,
1423                 amount_msat: 3460001,
1424                 cltv_expiry: htlc_cltv,
1425                 payment_hash,
1426                 transaction_output_index: Some(1),
1427         };
1428
1429         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1430
1431         let res = {
1432                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1433                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1434                 let local_chan_signer = local_chan.get_signer();
1435                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1436                         commitment_number,
1437                         95000,
1438                         local_chan_balance,
1439                         local_chan.opt_anchors(), local_funding, remote_funding,
1440                         commit_tx_keys.clone(),
1441                         feerate_per_kw,
1442                         &mut vec![(accepted_htlc_info, ())],
1443                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1444                 );
1445                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, Vec::new(), &secp_ctx).unwrap()
1446         };
1447
1448         let commit_signed_msg = msgs::CommitmentSigned {
1449                 channel_id: chan.2,
1450                 signature: res.0,
1451                 htlc_signatures: res.1
1452         };
1453
1454         // Send the commitment_signed message to the nodes[1].
1455         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1456         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1457
1458         // Send the RAA to nodes[1].
1459         let raa_msg = msgs::RevokeAndACK {
1460                 channel_id: chan.2,
1461                 per_commitment_secret: local_secret,
1462                 next_per_commitment_point: next_local_point
1463         };
1464         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1465
1466         let events = nodes[1].node.get_and_clear_pending_msg_events();
1467         assert_eq!(events.len(), 1);
1468         // Make sure the HTLC failed in the way we expect.
1469         match events[0] {
1470                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1471                         assert_eq!(update_fail_htlcs.len(), 1);
1472                         update_fail_htlcs[0].clone()
1473                 },
1474                 _ => panic!("Unexpected event"),
1475         };
1476         nodes[1].logger.assert_log("lightning::ln::channel".to_string(),
1477                 format!("Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", ::hex::encode(raa_msg.channel_id)), 1);
1478
1479         check_added_monitors!(nodes[1], 2);
1480 }
1481
1482 #[test]
1483 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1484         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1485         // Set the fee rate for the channel very high, to the point where the fundee
1486         // sending any above-dust amount would result in a channel reserve violation.
1487         // In this test we check that we would be prevented from sending an HTLC in
1488         // this situation.
1489         let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1490         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1491         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1492         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1493         let default_config = UserConfig::default();
1494         let opt_anchors = false;
1495
1496         let mut push_amt = 100_000_000;
1497         push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, opt_anchors);
1498
1499         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1500
1501         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1502
1503         // Sending exactly enough to hit the reserve amount should be accepted
1504         for _ in 0..MIN_AFFORDABLE_HTLC_COUNT {
1505                 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1506         }
1507
1508         // However one more HTLC should be significantly over the reserve amount and fail.
1509         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1_000_000);
1510         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1511                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1512         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1513         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);
1514 }
1515
1516 #[test]
1517 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1518         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1519         let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1520         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1521         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1522         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1523         let default_config = UserConfig::default();
1524         let opt_anchors = false;
1525
1526         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1527         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1528         // transaction fee with 0 HTLCs (183 sats)).
1529         let mut push_amt = 100_000_000;
1530         push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, opt_anchors);
1531         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1532         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, push_amt, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1533
1534         // Send four HTLCs to cover the initial push_msat buffer we're required to include
1535         for _ in 0..MIN_AFFORDABLE_HTLC_COUNT {
1536                 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1537         }
1538
1539         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 700_000);
1540         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1541         let secp_ctx = Secp256k1::new();
1542         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1543         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1544         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1545         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 700_000, &Some(payment_secret), cur_height, &None).unwrap();
1546         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1547         let msg = msgs::UpdateAddHTLC {
1548                 channel_id: chan.2,
1549                 htlc_id: MIN_AFFORDABLE_HTLC_COUNT as u64,
1550                 amount_msat: htlc_msat,
1551                 payment_hash: payment_hash,
1552                 cltv_expiry: htlc_cltv,
1553                 onion_routing_packet: onion_packet,
1554         };
1555
1556         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1557         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1558         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);
1559         assert_eq!(nodes[0].node.list_channels().len(), 0);
1560         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1561         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1562         check_added_monitors!(nodes[0], 1);
1563         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() });
1564 }
1565
1566 #[test]
1567 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1568         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1569         // calculating our commitment transaction fee (this was previously broken).
1570         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1571         let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1572
1573         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1574         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1575         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1576         let default_config = UserConfig::default();
1577         let opt_anchors = false;
1578
1579         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1580         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1581         // transaction fee with 0 HTLCs (183 sats)).
1582         let mut push_amt = 100_000_000;
1583         push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, opt_anchors);
1584         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1585         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, push_amt, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1586
1587         let dust_amt = crate::ln::channel::MIN_CHAN_DUST_LIMIT_SATOSHIS * 1000
1588                 + feerate_per_kw as u64 * htlc_success_tx_weight(opt_anchors) / 1000 * 1000 - 1;
1589         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1590         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1591         // commitment transaction fee.
1592         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1593
1594         // Send four HTLCs to cover the initial push_msat buffer we're required to include
1595         for _ in 0..MIN_AFFORDABLE_HTLC_COUNT {
1596                 let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], 1_000_000);
1597         }
1598
1599         // One more than the dust amt should fail, however.
1600         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], dust_amt + 1);
1601         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1602                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1603 }
1604
1605 #[test]
1606 fn test_chan_init_feerate_unaffordability() {
1607         // Test that we will reject channel opens which do not leave enough to pay for any HTLCs due to
1608         // channel reserve and feerate requirements.
1609         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1610         let feerate_per_kw = *chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1611         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1612         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1613         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1614         let default_config = UserConfig::default();
1615         let opt_anchors = false;
1616
1617         // Set the push_msat amount such that nodes[0] will not be able to afford to add even a single
1618         // HTLC.
1619         let mut push_amt = 100_000_000;
1620         push_amt -= commit_tx_fee_msat(feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT as u64, opt_anchors);
1621         assert_eq!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, push_amt + 1, 42, None).unwrap_err(),
1622                 APIError::APIMisuseError { err: "Funding amount (356) can't even pay fee for initial commitment transaction fee of 357.".to_string() });
1623
1624         // During open, we don't have a "counterparty channel reserve" to check against, so that
1625         // requirement only comes into play on the open_channel handling side.
1626         push_amt -= Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config) * 1000;
1627         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, push_amt, 42, None).unwrap();
1628         let mut open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
1629         open_channel_msg.push_msat += 1;
1630         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel_msg);
1631
1632         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1633         assert_eq!(msg_events.len(), 1);
1634         match msg_events[0] {
1635                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1636                         assert_eq!(msg.data, "Insufficient funding amount for initial reserve");
1637                 },
1638                 _ => panic!("Unexpected event"),
1639         }
1640 }
1641
1642 #[test]
1643 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1644         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1645         // calculating our counterparty's commitment transaction fee (this was previously broken).
1646         let chanmon_cfgs = create_chanmon_cfgs(2);
1647         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1648         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1649         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1650         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1651
1652         let payment_amt = 46000; // Dust amount
1653         // In the previous code, these first four payments would succeed.
1654         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1655         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1656         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1657         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1658
1659         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1660         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1661         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1662         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1663         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1664         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1665
1666         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1667         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1668         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1669         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1670 }
1671
1672 #[test]
1673 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1674         let chanmon_cfgs = create_chanmon_cfgs(3);
1675         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1676         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1677         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1678         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1679         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1680
1681         let feemsat = 239;
1682         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1683         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1684         let feerate = get_feerate!(nodes[0], chan.2);
1685         let opt_anchors = get_opt_anchors!(nodes[0], chan.2);
1686
1687         // Add a 2* and +1 for the fee spike reserve.
1688         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1, opt_anchors);
1689         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;
1690         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1691
1692         // Add a pending HTLC.
1693         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1694         let payment_event_1 = {
1695                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
1696                 check_added_monitors!(nodes[0], 1);
1697
1698                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1699                 assert_eq!(events.len(), 1);
1700                 SendEvent::from_event(events.remove(0))
1701         };
1702         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1703
1704         // Attempt to trigger a channel reserve violation --> payment failure.
1705         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2, opt_anchors);
1706         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;
1707         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1708         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1709
1710         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1711         let secp_ctx = Secp256k1::new();
1712         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1713         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1714         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1715         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height, &None).unwrap();
1716         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1717         let msg = msgs::UpdateAddHTLC {
1718                 channel_id: chan.2,
1719                 htlc_id: 1,
1720                 amount_msat: htlc_msat + 1,
1721                 payment_hash: our_payment_hash_1,
1722                 cltv_expiry: htlc_cltv,
1723                 onion_routing_packet: onion_packet,
1724         };
1725
1726         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1727         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1728         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1729         assert_eq!(nodes[1].node.list_channels().len(), 1);
1730         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1731         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1732         check_added_monitors!(nodes[1], 1);
1733         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote HTLC add would put them under remote reserve value".to_string() });
1734 }
1735
1736 #[test]
1737 fn test_inbound_outbound_capacity_is_not_zero() {
1738         let chanmon_cfgs = create_chanmon_cfgs(2);
1739         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1740         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1741         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1742         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1743         let channels0 = node_chanmgrs[0].list_channels();
1744         let channels1 = node_chanmgrs[1].list_channels();
1745         let default_config = UserConfig::default();
1746         assert_eq!(channels0.len(), 1);
1747         assert_eq!(channels1.len(), 1);
1748
1749         let reserve = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(100_000, &default_config);
1750         assert_eq!(channels0[0].inbound_capacity_msat, 95000000 - reserve*1000);
1751         assert_eq!(channels1[0].outbound_capacity_msat, 95000000 - reserve*1000);
1752
1753         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1754         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000 - reserve*1000);
1755 }
1756
1757 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64, opt_anchors: bool) -> u64 {
1758         (commitment_tx_base_weight(opt_anchors) + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1759 }
1760
1761 #[test]
1762 fn test_channel_reserve_holding_cell_htlcs() {
1763         let chanmon_cfgs = create_chanmon_cfgs(3);
1764         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1765         // When this test was written, the default base fee floated based on the HTLC count.
1766         // It is now fixed, so we simply set the fee to the expected value here.
1767         let mut config = test_default_channel_config();
1768         config.channel_config.forwarding_fee_base_msat = 239;
1769         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
1770         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1771         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1772         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1773
1774         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1775         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1776
1777         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1778         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1779
1780         macro_rules! expect_forward {
1781                 ($node: expr) => {{
1782                         let mut events = $node.node.get_and_clear_pending_msg_events();
1783                         assert_eq!(events.len(), 1);
1784                         check_added_monitors!($node, 1);
1785                         let payment_event = SendEvent::from_event(events.remove(0));
1786                         payment_event
1787                 }}
1788         }
1789
1790         let feemsat = 239; // set above
1791         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1792         let feerate = get_feerate!(nodes[0], chan_1.2);
1793         let opt_anchors = get_opt_anchors!(nodes[0], chan_1.2);
1794
1795         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1796
1797         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1798         {
1799                 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id())
1800                         .with_features(channelmanager::provided_invoice_features()).with_max_channel_saturation_power_of_half(0);
1801                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, recv_value_0, TEST_FINAL_CLTV);
1802                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1803                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1804
1805                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1806                         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)));
1807                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1808                 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);
1809         }
1810
1811         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1812         // nodes[0]'s wealth
1813         loop {
1814                 let amt_msat = recv_value_0 + total_fee_msat;
1815                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1816                 // Also, ensure that each payment has enough to be over the dust limit to
1817                 // ensure it'll be included in each commit tx fee calculation.
1818                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1, opt_anchors);
1819                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1820                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1821                         break;
1822                 }
1823
1824                 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id())
1825                         .with_features(channelmanager::provided_invoice_features()).with_max_channel_saturation_power_of_half(0);
1826                 let route = get_route!(nodes[0], payment_params, recv_value_0, TEST_FINAL_CLTV).unwrap();
1827                 let (payment_preimage, ..) = send_along_route(&nodes[0], route, &[&nodes[1], &nodes[2]], recv_value_0);
1828                 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
1829
1830                 let (stat01_, stat11_, stat12_, stat22_) = (
1831                         get_channel_value_stat!(nodes[0], chan_1.2),
1832                         get_channel_value_stat!(nodes[1], chan_1.2),
1833                         get_channel_value_stat!(nodes[1], chan_2.2),
1834                         get_channel_value_stat!(nodes[2], chan_2.2),
1835                 );
1836
1837                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1838                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1839                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1840                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1841                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1842         }
1843
1844         // adding pending output.
1845         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1846         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1847         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1848         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1849         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1850         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1851         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1852         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1853         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1854         // policy.
1855         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1, opt_anchors);
1856         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1857         let amt_msat_1 = recv_value_1 + total_fee_msat;
1858
1859         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);
1860         let payment_event_1 = {
1861                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1), PaymentId(our_payment_hash_1.0)).unwrap();
1862                 check_added_monitors!(nodes[0], 1);
1863
1864                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1865                 assert_eq!(events.len(), 1);
1866                 SendEvent::from_event(events.remove(0))
1867         };
1868         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1869
1870         // channel reserve test with htlc pending output > 0
1871         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1872         {
1873                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1874                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1875                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1876                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1877         }
1878
1879         // split the rest to test holding cell
1880         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1, opt_anchors);
1881         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1882         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1883         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1884         {
1885                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1886                 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);
1887         }
1888
1889         // now see if they go through on both sides
1890         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);
1891         // but this will stuck in the holding cell
1892         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21), PaymentId(our_payment_hash_21.0)).unwrap();
1893         check_added_monitors!(nodes[0], 0);
1894         let events = nodes[0].node.get_and_clear_pending_events();
1895         assert_eq!(events.len(), 0);
1896
1897         // test with outbound holding cell amount > 0
1898         {
1899                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
1900                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
1901                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1902                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1903                 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);
1904         }
1905
1906         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);
1907         // this will also stuck in the holding cell
1908         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22), PaymentId(our_payment_hash_22.0)).unwrap();
1909         check_added_monitors!(nodes[0], 0);
1910         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1911         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1912
1913         // flush the pending htlc
1914         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1915         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1916         check_added_monitors!(nodes[1], 1);
1917
1918         // the pending htlc should be promoted to committed
1919         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1920         check_added_monitors!(nodes[0], 1);
1921         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1922
1923         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1924         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1925         // No commitment_signed so get_event_msg's assert(len == 1) passes
1926         check_added_monitors!(nodes[0], 1);
1927
1928         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1929         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1930         check_added_monitors!(nodes[1], 1);
1931
1932         expect_pending_htlcs_forwardable!(nodes[1]);
1933
1934         let ref payment_event_11 = expect_forward!(nodes[1]);
1935         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1936         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1937
1938         expect_pending_htlcs_forwardable!(nodes[2]);
1939         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
1940
1941         // flush the htlcs in the holding cell
1942         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1943         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1944         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1945         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1946         expect_pending_htlcs_forwardable!(nodes[1]);
1947
1948         let ref payment_event_3 = expect_forward!(nodes[1]);
1949         assert_eq!(payment_event_3.msgs.len(), 2);
1950         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1951         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1952
1953         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1954         expect_pending_htlcs_forwardable!(nodes[2]);
1955
1956         let events = nodes[2].node.get_and_clear_pending_events();
1957         assert_eq!(events.len(), 2);
1958         match events[0] {
1959                 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1960                         assert_eq!(our_payment_hash_21, *payment_hash);
1961                         assert_eq!(recv_value_21, amount_msat);
1962                         match &purpose {
1963                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1964                                         assert!(payment_preimage.is_none());
1965                                         assert_eq!(our_payment_secret_21, *payment_secret);
1966                                 },
1967                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
1968                         }
1969                 },
1970                 _ => panic!("Unexpected event"),
1971         }
1972         match events[1] {
1973                 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1974                         assert_eq!(our_payment_hash_22, *payment_hash);
1975                         assert_eq!(recv_value_22, amount_msat);
1976                         match &purpose {
1977                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1978                                         assert!(payment_preimage.is_none());
1979                                         assert_eq!(our_payment_secret_22, *payment_secret);
1980                                 },
1981                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
1982                         }
1983                 },
1984                 _ => panic!("Unexpected event"),
1985         }
1986
1987         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
1988         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
1989         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
1990
1991         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1, opt_anchors);
1992         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
1993         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
1994
1995         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1, opt_anchors);
1996         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);
1997         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1998         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1999         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2000
2001         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2002         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2003 }
2004
2005 #[test]
2006 fn channel_reserve_in_flight_removes() {
2007         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2008         // can send to its counterparty, but due to update ordering, the other side may not yet have
2009         // considered those HTLCs fully removed.
2010         // This tests that we don't count HTLCs which will not be included in the next remote
2011         // commitment transaction towards the reserve value (as it implies no commitment transaction
2012         // will be generated which violates the remote reserve value).
2013         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2014         // To test this we:
2015         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2016         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2017         //    you only consider the value of the first HTLC, it may not),
2018         //  * start routing a third HTLC from A to B,
2019         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2020         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2021         //  * deliver the first fulfill from B
2022         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2023         //    claim,
2024         //  * deliver A's response CS and RAA.
2025         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2026         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2027         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2028         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2029         let chanmon_cfgs = create_chanmon_cfgs(2);
2030         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2031         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2032         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2033         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2034
2035         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2036         // Route the first two HTLCs.
2037         let payment_value_1 = b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000;
2038         let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], payment_value_1);
2039         let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20_000);
2040
2041         // Start routing the third HTLC (this is just used to get everyone in the right state).
2042         let (route, payment_hash_3, payment_preimage_3, payment_secret_3) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
2043         let send_1 = {
2044                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3), PaymentId(payment_hash_3.0)).unwrap();
2045                 check_added_monitors!(nodes[0], 1);
2046                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2047                 assert_eq!(events.len(), 1);
2048                 SendEvent::from_event(events.remove(0))
2049         };
2050
2051         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2052         // initial fulfill/CS.
2053         nodes[1].node.claim_funds(payment_preimage_1);
2054         expect_payment_claimed!(nodes[1], payment_hash_1, payment_value_1);
2055         check_added_monitors!(nodes[1], 1);
2056         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2057
2058         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2059         // remove the second HTLC when we send the HTLC back from B to A.
2060         nodes[1].node.claim_funds(payment_preimage_2);
2061         expect_payment_claimed!(nodes[1], payment_hash_2, 20_000);
2062         check_added_monitors!(nodes[1], 1);
2063         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2064
2065         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2066         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2067         check_added_monitors!(nodes[0], 1);
2068         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2069         expect_payment_sent_without_paths!(nodes[0], payment_preimage_1);
2070
2071         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2072         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2073         check_added_monitors!(nodes[1], 1);
2074         // B is already AwaitingRAA, so cant generate a CS here
2075         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2076
2077         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2078         check_added_monitors!(nodes[1], 1);
2079         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2080
2081         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2082         check_added_monitors!(nodes[0], 1);
2083         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2084
2085         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2086         check_added_monitors!(nodes[1], 1);
2087         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2088
2089         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2090         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2091         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2092         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2093         // on-chain as necessary).
2094         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2095         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2096         check_added_monitors!(nodes[0], 1);
2097         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2098         expect_payment_sent_without_paths!(nodes[0], payment_preimage_2);
2099
2100         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2101         check_added_monitors!(nodes[1], 1);
2102         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2103
2104         expect_pending_htlcs_forwardable!(nodes[1]);
2105         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2106
2107         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2108         // resolve the second HTLC from A's point of view.
2109         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2110         check_added_monitors!(nodes[0], 1);
2111         expect_payment_path_successful!(nodes[0]);
2112         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2113
2114         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2115         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2116         let (route, payment_hash_4, payment_preimage_4, payment_secret_4) = get_route_and_payment_hash!(nodes[1], nodes[0], 10000);
2117         let send_2 = {
2118                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4), PaymentId(payment_hash_4.0)).unwrap();
2119                 check_added_monitors!(nodes[1], 1);
2120                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2121                 assert_eq!(events.len(), 1);
2122                 SendEvent::from_event(events.remove(0))
2123         };
2124
2125         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2126         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2127         check_added_monitors!(nodes[0], 1);
2128         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2129
2130         // Now just resolve all the outstanding messages/HTLCs for completeness...
2131
2132         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2133         check_added_monitors!(nodes[1], 1);
2134         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2135
2136         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2137         check_added_monitors!(nodes[1], 1);
2138
2139         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2140         check_added_monitors!(nodes[0], 1);
2141         expect_payment_path_successful!(nodes[0]);
2142         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2143
2144         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2145         check_added_monitors!(nodes[1], 1);
2146         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2147
2148         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2149         check_added_monitors!(nodes[0], 1);
2150
2151         expect_pending_htlcs_forwardable!(nodes[0]);
2152         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2153
2154         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2155         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2156 }
2157
2158 #[test]
2159 fn channel_monitor_network_test() {
2160         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2161         // tests that ChannelMonitor is able to recover from various states.
2162         let chanmon_cfgs = create_chanmon_cfgs(5);
2163         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2164         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2165         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2166
2167         // Create some initial channels
2168         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2169         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2170         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2171         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2172
2173         // Make sure all nodes are at the same starting height
2174         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2175         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2176         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2177         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2178         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2179
2180         // Rebalance the network a bit by relaying one payment through all the channels...
2181         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2182         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2183         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2184         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2185
2186         // Simple case with no pending HTLCs:
2187         nodes[1].node.force_close_broadcasting_latest_txn(&chan_1.2, &nodes[0].node.get_our_node_id()).unwrap();
2188         check_added_monitors!(nodes[1], 1);
2189         check_closed_broadcast!(nodes[1], true);
2190         {
2191                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2192                 assert_eq!(node_txn.len(), 1);
2193                 mine_transaction(&nodes[0], &node_txn[0]);
2194                 check_added_monitors!(nodes[0], 1);
2195                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2196         }
2197         check_closed_broadcast!(nodes[0], true);
2198         assert_eq!(nodes[0].node.list_channels().len(), 0);
2199         assert_eq!(nodes[1].node.list_channels().len(), 1);
2200         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2201         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
2202
2203         // One pending HTLC is discarded by the force-close:
2204         let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[1], &[&nodes[2], &nodes[3]], 3_000_000);
2205
2206         // Simple case of one pending HTLC to HTLC-Timeout (note that the HTLC-Timeout is not
2207         // broadcasted until we reach the timelock time).
2208         nodes[1].node.force_close_broadcasting_latest_txn(&chan_2.2, &nodes[2].node.get_our_node_id()).unwrap();
2209         check_closed_broadcast!(nodes[1], true);
2210         check_added_monitors!(nodes[1], 1);
2211         {
2212                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::NONE);
2213                 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2214                 test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2215                 mine_transaction(&nodes[2], &node_txn[0]);
2216                 check_added_monitors!(nodes[2], 1);
2217                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2218         }
2219         check_closed_broadcast!(nodes[2], true);
2220         assert_eq!(nodes[1].node.list_channels().len(), 0);
2221         assert_eq!(nodes[2].node.list_channels().len(), 1);
2222         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
2223         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2224
2225         macro_rules! claim_funds {
2226                 ($node: expr, $prev_node: expr, $preimage: expr, $payment_hash: expr) => {
2227                         {
2228                                 $node.node.claim_funds($preimage);
2229                                 expect_payment_claimed!($node, $payment_hash, 3_000_000);
2230                                 check_added_monitors!($node, 1);
2231
2232                                 let events = $node.node.get_and_clear_pending_msg_events();
2233                                 assert_eq!(events.len(), 1);
2234                                 match events[0] {
2235                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2236                                                 assert!(update_add_htlcs.is_empty());
2237                                                 assert!(update_fail_htlcs.is_empty());
2238                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2239                                         },
2240                                         _ => panic!("Unexpected event"),
2241                                 };
2242                         }
2243                 }
2244         }
2245
2246         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2247         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2248         nodes[2].node.force_close_broadcasting_latest_txn(&chan_3.2, &nodes[3].node.get_our_node_id()).unwrap();
2249         check_added_monitors!(nodes[2], 1);
2250         check_closed_broadcast!(nodes[2], true);
2251         let node2_commitment_txid;
2252         {
2253                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::NONE);
2254                 connect_blocks(&nodes[2], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + MIN_CLTV_EXPIRY_DELTA as u32 + 1);
2255                 test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2256                 node2_commitment_txid = node_txn[0].txid();
2257
2258                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2259                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, payment_hash_1);
2260                 mine_transaction(&nodes[3], &node_txn[0]);
2261                 check_added_monitors!(nodes[3], 1);
2262                 check_preimage_claim(&nodes[3], &node_txn);
2263         }
2264         check_closed_broadcast!(nodes[3], true);
2265         assert_eq!(nodes[2].node.list_channels().len(), 0);
2266         assert_eq!(nodes[3].node.list_channels().len(), 1);
2267         check_closed_event!(nodes[2], 1, ClosureReason::HolderForceClosed);
2268         check_closed_event!(nodes[3], 1, ClosureReason::CommitmentTxConfirmed);
2269
2270         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2271         // confusing us in the following tests.
2272         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.remove_monitor(&OutPoint { txid: chan_3.3.txid(), index: 0 });
2273
2274         // One pending HTLC to time out:
2275         let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[3], &[&nodes[4]], 3_000_000);
2276         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2277         // buffer space).
2278
2279         let (close_chan_update_1, close_chan_update_2) = {
2280                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2281                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2282                 assert_eq!(events.len(), 2);
2283                 let close_chan_update_1 = match events[0] {
2284                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2285                                 msg.clone()
2286                         },
2287                         _ => panic!("Unexpected event"),
2288                 };
2289                 match events[1] {
2290                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2291                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2292                         },
2293                         _ => panic!("Unexpected event"),
2294                 }
2295                 check_added_monitors!(nodes[3], 1);
2296
2297                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2298                 {
2299                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2300                         node_txn.retain(|tx| {
2301                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2302                                         false
2303                                 } else { true }
2304                         });
2305                 }
2306
2307                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2308
2309                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2310                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, payment_hash_2);
2311
2312                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2313                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2314                 assert_eq!(events.len(), 2);
2315                 let close_chan_update_2 = match events[0] {
2316                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2317                                 msg.clone()
2318                         },
2319                         _ => panic!("Unexpected event"),
2320                 };
2321                 match events[1] {
2322                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2323                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2324                         },
2325                         _ => panic!("Unexpected event"),
2326                 }
2327                 check_added_monitors!(nodes[4], 1);
2328                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2329
2330                 mine_transaction(&nodes[4], &node_txn[0]);
2331                 check_preimage_claim(&nodes[4], &node_txn);
2332                 (close_chan_update_1, close_chan_update_2)
2333         };
2334         nodes[3].gossip_sync.handle_channel_update(&close_chan_update_2).unwrap();
2335         nodes[4].gossip_sync.handle_channel_update(&close_chan_update_1).unwrap();
2336         assert_eq!(nodes[3].node.list_channels().len(), 0);
2337         assert_eq!(nodes[4].node.list_channels().len(), 0);
2338
2339         assert_eq!(nodes[3].chain_monitor.chain_monitor.watch_channel(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon),
2340                 ChannelMonitorUpdateStatus::Completed);
2341         check_closed_event!(nodes[3], 1, ClosureReason::CommitmentTxConfirmed);
2342         check_closed_event!(nodes[4], 1, ClosureReason::CommitmentTxConfirmed);
2343 }
2344
2345 #[test]
2346 fn test_justice_tx() {
2347         // Test justice txn built on revoked HTLC-Success tx, against both sides
2348         let mut alice_config = UserConfig::default();
2349         alice_config.channel_handshake_config.announced_channel = true;
2350         alice_config.channel_handshake_limits.force_announced_channel_preference = false;
2351         alice_config.channel_handshake_config.our_to_self_delay = 6 * 24 * 5;
2352         let mut bob_config = UserConfig::default();
2353         bob_config.channel_handshake_config.announced_channel = true;
2354         bob_config.channel_handshake_limits.force_announced_channel_preference = false;
2355         bob_config.channel_handshake_config.our_to_self_delay = 6 * 24 * 3;
2356         let user_cfgs = [Some(alice_config), Some(bob_config)];
2357         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2358         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2359         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2360         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2361         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2362         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2363         *nodes[0].connect_style.borrow_mut() = ConnectStyle::FullBlockViaListen;
2364         // Create some new channels:
2365         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2366
2367         // A pending HTLC which will be revoked:
2368         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2369         // Get the will-be-revoked local txn from nodes[0]
2370         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2371         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2372         assert_eq!(revoked_local_txn[0].input.len(), 1);
2373         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2374         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2375         assert_eq!(revoked_local_txn[1].input.len(), 1);
2376         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2377         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2378         // Revoke the old state
2379         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2380
2381         {
2382                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2383                 {
2384                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2385                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2386                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2387
2388                         check_spends!(node_txn[0], revoked_local_txn[0]);
2389                         node_txn.swap_remove(0);
2390                         node_txn.truncate(1);
2391                 }
2392                 check_added_monitors!(nodes[1], 1);
2393                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2394                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2395
2396                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2397                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2398                 // Verify broadcast of revoked HTLC-timeout
2399                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2400                 check_added_monitors!(nodes[0], 1);
2401                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2402                 // Broadcast revoked HTLC-timeout on node 1
2403                 mine_transaction(&nodes[1], &node_txn[1]);
2404                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2405         }
2406         get_announce_close_broadcast_events(&nodes, 0, 1);
2407
2408         assert_eq!(nodes[0].node.list_channels().len(), 0);
2409         assert_eq!(nodes[1].node.list_channels().len(), 0);
2410
2411         // We test justice_tx build by A on B's revoked HTLC-Success tx
2412         // Create some new channels:
2413         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2414         {
2415                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2416                 node_txn.clear();
2417         }
2418
2419         // A pending HTLC which will be revoked:
2420         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2421         // Get the will-be-revoked local txn from B
2422         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2423         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2424         assert_eq!(revoked_local_txn[0].input.len(), 1);
2425         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2426         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2427         // Revoke the old state
2428         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2429         {
2430                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2431                 {
2432                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2433                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2434                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2435
2436                         check_spends!(node_txn[0], revoked_local_txn[0]);
2437                         node_txn.swap_remove(0);
2438                 }
2439                 check_added_monitors!(nodes[0], 1);
2440                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2441
2442                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2443                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2444                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2445                 check_added_monitors!(nodes[1], 1);
2446                 mine_transaction(&nodes[0], &node_txn[1]);
2447                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2448                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2449         }
2450         get_announce_close_broadcast_events(&nodes, 0, 1);
2451         assert_eq!(nodes[0].node.list_channels().len(), 0);
2452         assert_eq!(nodes[1].node.list_channels().len(), 0);
2453 }
2454
2455 #[test]
2456 fn revoked_output_claim() {
2457         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2458         // transaction is broadcast by its counterparty
2459         let chanmon_cfgs = create_chanmon_cfgs(2);
2460         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2461         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2462         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2463         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2464         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2465         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2466         assert_eq!(revoked_local_txn.len(), 1);
2467         // Only output is the full channel value back to nodes[0]:
2468         assert_eq!(revoked_local_txn[0].output.len(), 1);
2469         // Send a payment through, updating everyone's latest commitment txn
2470         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2471
2472         // Inform nodes[1] that nodes[0] broadcast a stale tx
2473         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2474         check_added_monitors!(nodes[1], 1);
2475         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2476         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2477         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2478
2479         check_spends!(node_txn[0], revoked_local_txn[0]);
2480         check_spends!(node_txn[1], chan_1.3);
2481
2482         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2483         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2484         get_announce_close_broadcast_events(&nodes, 0, 1);
2485         check_added_monitors!(nodes[0], 1);
2486         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2487 }
2488
2489 #[test]
2490 fn claim_htlc_outputs_shared_tx() {
2491         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2492         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2493         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2494         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2495         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2496         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2497
2498         // Create some new channel:
2499         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2500
2501         // Rebalance the network to generate htlc in the two directions
2502         send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
2503         // 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
2504         let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1]], 3_000_000).0;
2505         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
2506
2507         // Get the will-be-revoked local txn from node[0]
2508         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2509         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2510         assert_eq!(revoked_local_txn[0].input.len(), 1);
2511         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2512         assert_eq!(revoked_local_txn[1].input.len(), 1);
2513         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2514         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2515         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2516
2517         //Revoke the old state
2518         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2519
2520         {
2521                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2522                 check_added_monitors!(nodes[0], 1);
2523                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2524                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2525                 check_added_monitors!(nodes[1], 1);
2526                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2527                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2528                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2529
2530                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2531                 assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment
2532
2533                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2534                 check_spends!(node_txn[0], revoked_local_txn[0]);
2535
2536                 let mut witness_lens = BTreeSet::new();
2537                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2538                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2539                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2540                 assert_eq!(witness_lens.len(), 3);
2541                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2542                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2543                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2544
2545                 // Next nodes[1] broadcasts its current local tx state:
2546                 assert_eq!(node_txn[1].input.len(), 1);
2547                 check_spends!(node_txn[1], chan_1.3);
2548
2549                 // Finally, mine the penalty transaction and check that we get an HTLC failure after
2550                 // ANTI_REORG_DELAY confirmations.
2551                 mine_transaction(&nodes[1], &node_txn[0]);
2552                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2553                 expect_payment_failed!(nodes[1], payment_hash_2, false);
2554         }
2555         get_announce_close_broadcast_events(&nodes, 0, 1);
2556         assert_eq!(nodes[0].node.list_channels().len(), 0);
2557         assert_eq!(nodes[1].node.list_channels().len(), 0);
2558 }
2559
2560 #[test]
2561 fn claim_htlc_outputs_single_tx() {
2562         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2563         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2564         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2565         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2566         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2567         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2568
2569         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2570
2571         // Rebalance the network to generate htlc in the two directions
2572         send_payment(&nodes[0], &[&nodes[1]], 8_000_000);
2573         // 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
2574         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2575         let payment_preimage_1 = route_payment(&nodes[0], &[&nodes[1]], 3_000_000).0;
2576         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
2577
2578         // Get the will-be-revoked local txn from node[0]
2579         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2580
2581         //Revoke the old state
2582         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2583
2584         {
2585                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2586                 check_added_monitors!(nodes[0], 1);
2587                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2588                 check_added_monitors!(nodes[1], 1);
2589                 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2590                 let mut events = nodes[0].node.get_and_clear_pending_events();
2591                 expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
2592                 match events.last().unwrap() {
2593                         Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2594                         _ => panic!("Unexpected event"),
2595                 }
2596
2597                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2598                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2599
2600                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2601                 assert!(node_txn.len() == 9 || node_txn.len() == 10);
2602
2603                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2604                 assert_eq!(node_txn[0].input.len(), 1);
2605                 check_spends!(node_txn[0], chan_1.3);
2606                 assert_eq!(node_txn[1].input.len(), 1);
2607                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2608                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2609                 check_spends!(node_txn[1], node_txn[0]);
2610
2611                 // Justice transactions are indices 1-2-4
2612                 assert_eq!(node_txn[2].input.len(), 1);
2613                 assert_eq!(node_txn[3].input.len(), 1);
2614                 assert_eq!(node_txn[4].input.len(), 1);
2615
2616                 check_spends!(node_txn[2], revoked_local_txn[0]);
2617                 check_spends!(node_txn[3], revoked_local_txn[0]);
2618                 check_spends!(node_txn[4], revoked_local_txn[0]);
2619
2620                 let mut witness_lens = BTreeSet::new();
2621                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2622                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2623                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2624                 assert_eq!(witness_lens.len(), 3);
2625                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2626                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2627                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2628
2629                 // Finally, mine the penalty transactions and check that we get an HTLC failure after
2630                 // ANTI_REORG_DELAY confirmations.
2631                 mine_transaction(&nodes[1], &node_txn[2]);
2632                 mine_transaction(&nodes[1], &node_txn[3]);
2633                 mine_transaction(&nodes[1], &node_txn[4]);
2634                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2635                 expect_payment_failed!(nodes[1], payment_hash_2, false);
2636         }
2637         get_announce_close_broadcast_events(&nodes, 0, 1);
2638         assert_eq!(nodes[0].node.list_channels().len(), 0);
2639         assert_eq!(nodes[1].node.list_channels().len(), 0);
2640 }
2641
2642 #[test]
2643 fn test_htlc_on_chain_success() {
2644         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2645         // the preimage backward accordingly. So here we test that ChannelManager is
2646         // broadcasting the right event to other nodes in payment path.
2647         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2648         // A --------------------> B ----------------------> C (preimage)
2649         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2650         // commitment transaction was broadcast.
2651         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2652         // towards B.
2653         // B should be able to claim via preimage if A then broadcasts its local tx.
2654         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2655         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2656         // PaymentSent event).
2657
2658         let chanmon_cfgs = create_chanmon_cfgs(3);
2659         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2660         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2661         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2662
2663         // Create some initial channels
2664         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2665         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2666
2667         // Ensure all nodes are at the same height
2668         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
2669         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
2670         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
2671         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
2672
2673         // Rebalance the network a bit by relaying one payment through all the channels...
2674         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2675         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2676
2677         let (our_payment_preimage, payment_hash_1, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
2678         let (our_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
2679
2680         // Broadcast legit commitment tx from C on B's chain
2681         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2682         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2683         assert_eq!(commitment_tx.len(), 1);
2684         check_spends!(commitment_tx[0], chan_2.3);
2685         nodes[2].node.claim_funds(our_payment_preimage);
2686         expect_payment_claimed!(nodes[2], payment_hash_1, 3_000_000);
2687         nodes[2].node.claim_funds(our_payment_preimage_2);
2688         expect_payment_claimed!(nodes[2], payment_hash_2, 3_000_000);
2689         check_added_monitors!(nodes[2], 2);
2690         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2691         assert!(updates.update_add_htlcs.is_empty());
2692         assert!(updates.update_fail_htlcs.is_empty());
2693         assert!(updates.update_fail_malformed_htlcs.is_empty());
2694         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2695
2696         mine_transaction(&nodes[2], &commitment_tx[0]);
2697         check_closed_broadcast!(nodes[2], true);
2698         check_added_monitors!(nodes[2], 1);
2699         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2700         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)
2701         assert_eq!(node_txn.len(), 5);
2702         assert_eq!(node_txn[0], node_txn[3]);
2703         assert_eq!(node_txn[1], node_txn[4]);
2704         assert_eq!(node_txn[2], commitment_tx[0]);
2705         check_spends!(node_txn[0], commitment_tx[0]);
2706         check_spends!(node_txn[1], commitment_tx[0]);
2707         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2708         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2709         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2710         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2711         assert_eq!(node_txn[0].lock_time.0, 0);
2712         assert_eq!(node_txn[1].lock_time.0, 0);
2713
2714         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2715         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
2716         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2717         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
2718         {
2719                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2720                 assert_eq!(added_monitors.len(), 1);
2721                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2722                 added_monitors.clear();
2723         }
2724         let forwarded_events = nodes[1].node.get_and_clear_pending_events();
2725         assert_eq!(forwarded_events.len(), 3);
2726         match forwarded_events[0] {
2727                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
2728                 _ => panic!("Unexpected event"),
2729         }
2730         let chan_id = Some(chan_1.2);
2731         match forwarded_events[1] {
2732                 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
2733                         assert_eq!(fee_earned_msat, Some(1000));
2734                         assert_eq!(prev_channel_id, chan_id);
2735                         assert_eq!(claim_from_onchain_tx, true);
2736                         assert_eq!(next_channel_id, Some(chan_2.2));
2737                 },
2738                 _ => panic!()
2739         }
2740         match forwarded_events[2] {
2741                 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
2742                         assert_eq!(fee_earned_msat, Some(1000));
2743                         assert_eq!(prev_channel_id, chan_id);
2744                         assert_eq!(claim_from_onchain_tx, true);
2745                         assert_eq!(next_channel_id, Some(chan_2.2));
2746                 },
2747                 _ => panic!()
2748         }
2749         let events = nodes[1].node.get_and_clear_pending_msg_events();
2750         {
2751                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2752                 assert_eq!(added_monitors.len(), 2);
2753                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2754                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2755                 added_monitors.clear();
2756         }
2757         assert_eq!(events.len(), 3);
2758         match events[0] {
2759                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2760                 _ => panic!("Unexpected event"),
2761         }
2762         match events[1] {
2763                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2764                 _ => panic!("Unexpected event"),
2765         }
2766
2767         match events[2] {
2768                 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, .. } } => {
2769                         assert!(update_add_htlcs.is_empty());
2770                         assert!(update_fail_htlcs.is_empty());
2771                         assert_eq!(update_fulfill_htlcs.len(), 1);
2772                         assert!(update_fail_malformed_htlcs.is_empty());
2773                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2774                 },
2775                 _ => panic!("Unexpected event"),
2776         };
2777         macro_rules! check_tx_local_broadcast {
2778                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2779                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2780                         assert_eq!(node_txn.len(), 3);
2781                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2782                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2783                         check_spends!(node_txn[1], $commitment_tx);
2784                         check_spends!(node_txn[2], $commitment_tx);
2785                         assert_ne!(node_txn[1].lock_time.0, 0);
2786                         assert_ne!(node_txn[2].lock_time.0, 0);
2787                         if $htlc_offered {
2788                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2789                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2790                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2791                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2792                         } else {
2793                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2794                                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2795                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2796                                 assert!(node_txn[2].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2797                         }
2798                         check_spends!(node_txn[0], $chan_tx);
2799                         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2800                         node_txn.clear();
2801                 } }
2802         }
2803         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2804         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2805         // timeout-claim of the output that nodes[2] just claimed via success.
2806         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2807
2808         // Broadcast legit commitment tx from A on B's chain
2809         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2810         let node_a_commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2811         check_spends!(node_a_commitment_tx[0], chan_1.3);
2812         mine_transaction(&nodes[1], &node_a_commitment_tx[0]);
2813         check_closed_broadcast!(nodes[1], true);
2814         check_added_monitors!(nodes[1], 1);
2815         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2816         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
2817         assert_eq!(node_txn.len(), 6); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 3 (HTLC-Success, 2* RBF bumps of above HTLC txn)
2818         let commitment_spend =
2819                 if node_txn[0].input[0].previous_output.txid == node_a_commitment_tx[0].txid() {
2820                         check_spends!(node_txn[1], commitment_tx[0]);
2821                         check_spends!(node_txn[2], commitment_tx[0]);
2822                         assert_ne!(node_txn[1].input[0].previous_output.vout, node_txn[2].input[0].previous_output.vout);
2823                         &node_txn[0]
2824                 } else {
2825                         check_spends!(node_txn[0], commitment_tx[0]);
2826                         check_spends!(node_txn[1], commitment_tx[0]);
2827                         assert_ne!(node_txn[0].input[0].previous_output.vout, node_txn[1].input[0].previous_output.vout);
2828                         &node_txn[2]
2829                 };
2830
2831         check_spends!(commitment_spend, node_a_commitment_tx[0]);
2832         assert_eq!(commitment_spend.input.len(), 2);
2833         assert_eq!(commitment_spend.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2834         assert_eq!(commitment_spend.input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2835         assert_eq!(commitment_spend.lock_time.0, 0);
2836         assert!(commitment_spend.output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2837         check_spends!(node_txn[3], chan_1.3);
2838         assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2839         check_spends!(node_txn[4], node_txn[3]);
2840         check_spends!(node_txn[5], node_txn[3]);
2841         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2842         // we already checked the same situation with A.
2843
2844         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2845         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
2846         connect_block(&nodes[0], &Block { header, txdata: vec![node_a_commitment_tx[0].clone(), commitment_spend.clone()] });
2847         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2848         check_closed_broadcast!(nodes[0], true);
2849         check_added_monitors!(nodes[0], 1);
2850         let events = nodes[0].node.get_and_clear_pending_events();
2851         assert_eq!(events.len(), 5);
2852         let mut first_claimed = false;
2853         for event in events {
2854                 match event {
2855                         Event::PaymentSent { payment_preimage, payment_hash, .. } => {
2856                                 if payment_preimage == our_payment_preimage && payment_hash == payment_hash_1 {
2857                                         assert!(!first_claimed);
2858                                         first_claimed = true;
2859                                 } else {
2860                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2861                                         assert_eq!(payment_hash, payment_hash_2);
2862                                 }
2863                         },
2864                         Event::PaymentPathSuccessful { .. } => {},
2865                         Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {},
2866                         _ => panic!("Unexpected event"),
2867                 }
2868         }
2869         check_tx_local_broadcast!(nodes[0], true, node_a_commitment_tx[0], chan_1.3);
2870 }
2871
2872 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2873         // Test that in case of a unilateral close onchain, we detect the state of output and
2874         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2875         // broadcasting the right event to other nodes in payment path.
2876         // A ------------------> B ----------------------> C (timeout)
2877         //    B's commitment tx                 C's commitment tx
2878         //            \                                  \
2879         //         B's HTLC timeout tx               B's timeout tx
2880
2881         let chanmon_cfgs = create_chanmon_cfgs(3);
2882         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2883         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2884         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2885         *nodes[0].connect_style.borrow_mut() = connect_style;
2886         *nodes[1].connect_style.borrow_mut() = connect_style;
2887         *nodes[2].connect_style.borrow_mut() = connect_style;
2888
2889         // Create some intial channels
2890         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2891         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2892
2893         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2894         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2895         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2896
2897         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2898
2899         // Broadcast legit commitment tx from C on B's chain
2900         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2901         check_spends!(commitment_tx[0], chan_2.3);
2902         nodes[2].node.fail_htlc_backwards(&payment_hash);
2903         check_added_monitors!(nodes[2], 0);
2904         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
2905         check_added_monitors!(nodes[2], 1);
2906
2907         let events = nodes[2].node.get_and_clear_pending_msg_events();
2908         assert_eq!(events.len(), 1);
2909         match events[0] {
2910                 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, .. } } => {
2911                         assert!(update_add_htlcs.is_empty());
2912                         assert!(!update_fail_htlcs.is_empty());
2913                         assert!(update_fulfill_htlcs.is_empty());
2914                         assert!(update_fail_malformed_htlcs.is_empty());
2915                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2916                 },
2917                 _ => panic!("Unexpected event"),
2918         };
2919         mine_transaction(&nodes[2], &commitment_tx[0]);
2920         check_closed_broadcast!(nodes[2], true);
2921         check_added_monitors!(nodes[2], 1);
2922         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
2923         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2924         assert_eq!(node_txn.len(), 1);
2925         check_spends!(node_txn[0], chan_2.3);
2926         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2927
2928         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2929         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2930         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2931         mine_transaction(&nodes[1], &commitment_tx[0]);
2932         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
2933         let timeout_tx;
2934         {
2935                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2936                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2937                 assert_eq!(node_txn[0], node_txn[3]);
2938                 assert_eq!(node_txn[1], node_txn[4]);
2939
2940                 check_spends!(node_txn[2], commitment_tx[0]);
2941                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2942
2943                 check_spends!(node_txn[0], chan_2.3);
2944                 check_spends!(node_txn[1], node_txn[0]);
2945                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2946                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2947
2948                 timeout_tx = node_txn[2].clone();
2949                 node_txn.clear();
2950         }
2951
2952         mine_transaction(&nodes[1], &timeout_tx);
2953         check_added_monitors!(nodes[1], 1);
2954         check_closed_broadcast!(nodes[1], true);
2955
2956         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2957
2958         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
2959         check_added_monitors!(nodes[1], 1);
2960         let events = nodes[1].node.get_and_clear_pending_msg_events();
2961         assert_eq!(events.len(), 1);
2962         match events[0] {
2963                 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, .. } } => {
2964                         assert!(update_add_htlcs.is_empty());
2965                         assert!(!update_fail_htlcs.is_empty());
2966                         assert!(update_fulfill_htlcs.is_empty());
2967                         assert!(update_fail_malformed_htlcs.is_empty());
2968                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2969                 },
2970                 _ => panic!("Unexpected event"),
2971         };
2972
2973         // Broadcast legit commitment tx from B on A's chain
2974         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2975         check_spends!(commitment_tx[0], chan_1.3);
2976
2977         mine_transaction(&nodes[0], &commitment_tx[0]);
2978         connect_blocks(&nodes[0], TEST_FINAL_CLTV + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
2979
2980         check_closed_broadcast!(nodes[0], true);
2981         check_added_monitors!(nodes[0], 1);
2982         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
2983         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 commitment tx, ChannelMonitor : 1 timeout tx
2984         assert_eq!(node_txn.len(), 2);
2985         check_spends!(node_txn[0], chan_1.3);
2986         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2987         check_spends!(node_txn[1], commitment_tx[0]);
2988         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2989 }
2990
2991 #[test]
2992 fn test_htlc_on_chain_timeout() {
2993         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
2994         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
2995         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
2996 }
2997
2998 #[test]
2999 fn test_simple_commitment_revoked_fail_backward() {
3000         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3001         // and fail backward accordingly.
3002
3003         let chanmon_cfgs = create_chanmon_cfgs(3);
3004         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3005         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3006         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3007
3008         // Create some initial channels
3009         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3010         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3011
3012         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3013         // Get the will-be-revoked local txn from nodes[2]
3014         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3015         // Revoke the old state
3016         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3017
3018         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3019
3020         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3021         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3022         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3023         check_added_monitors!(nodes[1], 1);
3024         check_closed_broadcast!(nodes[1], true);
3025
3026         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
3027         check_added_monitors!(nodes[1], 1);
3028         let events = nodes[1].node.get_and_clear_pending_msg_events();
3029         assert_eq!(events.len(), 1);
3030         match events[0] {
3031                 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, .. } } => {
3032                         assert!(update_add_htlcs.is_empty());
3033                         assert_eq!(update_fail_htlcs.len(), 1);
3034                         assert!(update_fulfill_htlcs.is_empty());
3035                         assert!(update_fail_malformed_htlcs.is_empty());
3036                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3037
3038                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3039                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3040                         expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_2.0.contents.short_channel_id, true);
3041                 },
3042                 _ => panic!("Unexpected event"),
3043         }
3044 }
3045
3046 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3047         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3048         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3049         // commitment transaction anymore.
3050         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3051         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3052         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3053         // technically disallowed and we should probably handle it reasonably.
3054         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3055         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3056         // transactions:
3057         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3058         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3059         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3060         //   and once they revoke the previous commitment transaction (allowing us to send a new
3061         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3062         let chanmon_cfgs = create_chanmon_cfgs(3);
3063         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3064         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3065         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3066
3067         // Create some initial channels
3068         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3069         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3070
3071         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 });
3072         // Get the will-be-revoked local txn from nodes[2]
3073         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3074         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3075         // Revoke the old state
3076         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3077
3078         let value = if use_dust {
3079                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3080                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3081                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3082         } else { 3000000 };
3083
3084         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3085         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3086         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3087
3088         nodes[2].node.fail_htlc_backwards(&first_payment_hash);
3089         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: first_payment_hash }]);
3090         check_added_monitors!(nodes[2], 1);
3091         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3092         assert!(updates.update_add_htlcs.is_empty());
3093         assert!(updates.update_fulfill_htlcs.is_empty());
3094         assert!(updates.update_fail_malformed_htlcs.is_empty());
3095         assert_eq!(updates.update_fail_htlcs.len(), 1);
3096         assert!(updates.update_fee.is_none());
3097         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3098         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3099         // Drop the last RAA from 3 -> 2
3100
3101         nodes[2].node.fail_htlc_backwards(&second_payment_hash);
3102         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: second_payment_hash }]);
3103         check_added_monitors!(nodes[2], 1);
3104         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3105         assert!(updates.update_add_htlcs.is_empty());
3106         assert!(updates.update_fulfill_htlcs.is_empty());
3107         assert!(updates.update_fail_malformed_htlcs.is_empty());
3108         assert_eq!(updates.update_fail_htlcs.len(), 1);
3109         assert!(updates.update_fee.is_none());
3110         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3111         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3112         check_added_monitors!(nodes[1], 1);
3113         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3114         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3115         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3116         check_added_monitors!(nodes[2], 1);
3117
3118         nodes[2].node.fail_htlc_backwards(&third_payment_hash);
3119         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: third_payment_hash }]);
3120         check_added_monitors!(nodes[2], 1);
3121         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3122         assert!(updates.update_add_htlcs.is_empty());
3123         assert!(updates.update_fulfill_htlcs.is_empty());
3124         assert!(updates.update_fail_malformed_htlcs.is_empty());
3125         assert_eq!(updates.update_fail_htlcs.len(), 1);
3126         assert!(updates.update_fee.is_none());
3127         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3128         // At this point first_payment_hash has dropped out of the latest two commitment
3129         // transactions that nodes[1] is tracking...
3130         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3131         check_added_monitors!(nodes[1], 1);
3132         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3133         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3134         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3135         check_added_monitors!(nodes[2], 1);
3136
3137         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3138         // on nodes[2]'s RAA.
3139         let (route, fourth_payment_hash, _, fourth_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 1000000);
3140         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret), PaymentId(fourth_payment_hash.0)).unwrap();
3141         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3142         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3143         check_added_monitors!(nodes[1], 0);
3144
3145         if deliver_bs_raa {
3146                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3147                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3148                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3149                 check_added_monitors!(nodes[1], 1);
3150                 let events = nodes[1].node.get_and_clear_pending_events();
3151                 assert_eq!(events.len(), 2);
3152                 match events[0] {
3153                         Event::PendingHTLCsForwardable { .. } => { },
3154                         _ => panic!("Unexpected event"),
3155                 };
3156                 match events[1] {
3157                         Event::HTLCHandlingFailed { .. } => { },
3158                         _ => panic!("Unexpected event"),
3159                 }
3160                 // Deliberately don't process the pending fail-back so they all fail back at once after
3161                 // block connection just like the !deliver_bs_raa case
3162         }
3163
3164         let mut failed_htlcs = HashSet::new();
3165         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3166
3167         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3168         check_added_monitors!(nodes[1], 1);
3169         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3170
3171         let events = nodes[1].node.get_and_clear_pending_events();
3172         assert_eq!(events.len(), if deliver_bs_raa { 2 + nodes.len() - 1 } else { 3 + nodes.len() });
3173         match events[0] {
3174                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => { },
3175                 _ => panic!("Unexepected event"),
3176         }
3177         match events[1] {
3178                 Event::PaymentPathFailed { ref payment_hash, .. } => {
3179                         assert_eq!(*payment_hash, fourth_payment_hash);
3180                 },
3181                 _ => panic!("Unexpected event"),
3182         }
3183         if !deliver_bs_raa {
3184                 match events[2] {
3185                         Event::PendingHTLCsForwardable { .. } => { },
3186                         _ => panic!("Unexpected event"),
3187                 };
3188                 nodes[1].node.abandon_payment(PaymentId(fourth_payment_hash.0));
3189                 let payment_failed_events = nodes[1].node.get_and_clear_pending_events();
3190                 assert_eq!(payment_failed_events.len(), 1);
3191                 match payment_failed_events[0] {
3192                         Event::PaymentFailed { ref payment_hash, .. } => {
3193                                 assert_eq!(*payment_hash, fourth_payment_hash);
3194                         },
3195                         _ => panic!("Unexpected event"),
3196                 }
3197         }
3198         nodes[1].node.process_pending_htlc_forwards();
3199         check_added_monitors!(nodes[1], 1);
3200
3201         let events = nodes[1].node.get_and_clear_pending_msg_events();
3202         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3203         match events[if deliver_bs_raa { 1 } else { 0 }] {
3204                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3205                 _ => panic!("Unexpected event"),
3206         }
3207         match events[if deliver_bs_raa { 2 } else { 1 }] {
3208                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3209                         assert_eq!(channel_id, chan_2.2);
3210                         assert_eq!(data.as_str(), "Channel closed because commitment or closing transaction was confirmed on chain.");
3211                 },
3212                 _ => panic!("Unexpected event"),
3213         }
3214         if deliver_bs_raa {
3215                 match events[0] {
3216                         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, .. } } => {
3217                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3218                                 assert_eq!(update_add_htlcs.len(), 1);
3219                                 assert!(update_fulfill_htlcs.is_empty());
3220                                 assert!(update_fail_htlcs.is_empty());
3221                                 assert!(update_fail_malformed_htlcs.is_empty());
3222                         },
3223                         _ => panic!("Unexpected event"),
3224                 }
3225         }
3226         match events[if deliver_bs_raa { 3 } else { 2 }] {
3227                 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, .. } } => {
3228                         assert!(update_add_htlcs.is_empty());
3229                         assert_eq!(update_fail_htlcs.len(), 3);
3230                         assert!(update_fulfill_htlcs.is_empty());
3231                         assert!(update_fail_malformed_htlcs.is_empty());
3232                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3233
3234                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3235                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3236                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3237
3238                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3239
3240                         let events = nodes[0].node.get_and_clear_pending_events();
3241                         assert_eq!(events.len(), 3);
3242                         match events[0] {
3243                                 Event::PaymentPathFailed { ref payment_hash, ref network_update, .. } => {
3244                                         assert!(failed_htlcs.insert(payment_hash.0));
3245                                         // If we delivered B's RAA we got an unknown preimage error, not something
3246                                         // that we should update our routing table for.
3247                                         if !deliver_bs_raa {
3248                                                 assert!(network_update.is_some());
3249                                         }
3250                                 },
3251                                 _ => panic!("Unexpected event"),
3252                         }
3253                         match events[1] {
3254                                 Event::PaymentPathFailed { ref payment_hash, ref network_update, .. } => {
3255                                         assert!(failed_htlcs.insert(payment_hash.0));
3256                                         assert!(network_update.is_some());
3257                                 },
3258                                 _ => panic!("Unexpected event"),
3259                         }
3260                         match events[2] {
3261                                 Event::PaymentPathFailed { ref payment_hash, ref network_update, .. } => {
3262                                         assert!(failed_htlcs.insert(payment_hash.0));
3263                                         assert!(network_update.is_some());
3264                                 },
3265                                 _ => panic!("Unexpected event"),
3266                         }
3267                 },
3268                 _ => panic!("Unexpected event"),
3269         }
3270
3271         assert!(failed_htlcs.contains(&first_payment_hash.0));
3272         assert!(failed_htlcs.contains(&second_payment_hash.0));
3273         assert!(failed_htlcs.contains(&third_payment_hash.0));
3274 }
3275
3276 #[test]
3277 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3278         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3279         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3280         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3281         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3282 }
3283
3284 #[test]
3285 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3286         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3287         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3288         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3289         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3290 }
3291
3292 #[test]
3293 fn fail_backward_pending_htlc_upon_channel_failure() {
3294         let chanmon_cfgs = create_chanmon_cfgs(2);
3295         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3296         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3297         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3298         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3299
3300         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3301         {
3302                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 50_000);
3303                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
3304                 check_added_monitors!(nodes[0], 1);
3305
3306                 let payment_event = {
3307                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3308                         assert_eq!(events.len(), 1);
3309                         SendEvent::from_event(events.remove(0))
3310                 };
3311                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3312                 assert_eq!(payment_event.msgs.len(), 1);
3313         }
3314
3315         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3316         let (route, failed_payment_hash, _, failed_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 50_000);
3317         {
3318                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret), PaymentId(failed_payment_hash.0)).unwrap();
3319                 check_added_monitors!(nodes[0], 0);
3320
3321                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3322         }
3323
3324         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3325         {
3326                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 50_000);
3327
3328                 let secp_ctx = Secp256k1::new();
3329                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3330                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3331                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height, &None).unwrap();
3332                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3333                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3334
3335                 // Send a 0-msat update_add_htlc to fail the channel.
3336                 let update_add_htlc = msgs::UpdateAddHTLC {
3337                         channel_id: chan.2,
3338                         htlc_id: 0,
3339                         amount_msat: 0,
3340                         payment_hash,
3341                         cltv_expiry,
3342                         onion_routing_packet,
3343                 };
3344                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3345         }
3346         let events = nodes[0].node.get_and_clear_pending_events();
3347         assert_eq!(events.len(), 2);
3348         // Check that Alice fails backward the pending HTLC from the second payment.
3349         match events[0] {
3350                 Event::PaymentPathFailed { payment_hash, .. } => {
3351                         assert_eq!(payment_hash, failed_payment_hash);
3352                 },
3353                 _ => panic!("Unexpected event"),
3354         }
3355         match events[1] {
3356                 Event::ChannelClosed { reason: ClosureReason::ProcessingError { ref err }, .. } => {
3357                         assert_eq!(err, "Remote side tried to send a 0-msat HTLC");
3358                 },
3359                 _ => panic!("Unexpected event {:?}", events[1]),
3360         }
3361         check_closed_broadcast!(nodes[0], true);
3362         check_added_monitors!(nodes[0], 1);
3363 }
3364
3365 #[test]
3366 fn test_htlc_ignore_latest_remote_commitment() {
3367         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3368         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3369         let chanmon_cfgs = create_chanmon_cfgs(2);
3370         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3371         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3372         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3373         if *nodes[1].connect_style.borrow() == ConnectStyle::FullBlockViaListen {
3374                 // We rely on the ability to connect a block redundantly, which isn't allowed via
3375                 // `chain::Listen`, so we never run the test if we randomly get assigned that
3376                 // connect_style.
3377                 return;
3378         }
3379         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3380
3381         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3382         nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
3383         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
3384         check_closed_broadcast!(nodes[0], true);
3385         check_added_monitors!(nodes[0], 1);
3386         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
3387
3388         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3389         assert_eq!(node_txn.len(), 3);
3390         assert_eq!(node_txn[0], node_txn[1]);
3391
3392         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
3393         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3394         check_closed_broadcast!(nodes[1], true);
3395         check_added_monitors!(nodes[1], 1);
3396         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3397
3398         // Duplicate the connect_block call since this may happen due to other listeners
3399         // registering new transactions
3400         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[2].clone()]});
3401 }
3402
3403 #[test]
3404 fn test_force_close_fail_back() {
3405         // Check which HTLCs are failed-backwards on channel force-closure
3406         let chanmon_cfgs = create_chanmon_cfgs(3);
3407         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3408         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3409         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3410         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3411         create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3412
3413         let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 1000000);
3414
3415         let mut payment_event = {
3416                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
3417                 check_added_monitors!(nodes[0], 1);
3418
3419                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3420                 assert_eq!(events.len(), 1);
3421                 SendEvent::from_event(events.remove(0))
3422         };
3423
3424         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3425         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3426
3427         expect_pending_htlcs_forwardable!(nodes[1]);
3428
3429         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3430         assert_eq!(events_2.len(), 1);
3431         payment_event = SendEvent::from_event(events_2.remove(0));
3432         assert_eq!(payment_event.msgs.len(), 1);
3433
3434         check_added_monitors!(nodes[1], 1);
3435         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3436         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3437         check_added_monitors!(nodes[2], 1);
3438         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3439
3440         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3441         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3442         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3443
3444         nodes[2].node.force_close_broadcasting_latest_txn(&payment_event.commitment_msg.channel_id, &nodes[1].node.get_our_node_id()).unwrap();
3445         check_closed_broadcast!(nodes[2], true);
3446         check_added_monitors!(nodes[2], 1);
3447         check_closed_event!(nodes[2], 1, ClosureReason::HolderForceClosed);
3448         let tx = {
3449                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3450                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3451                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3452                 // back to nodes[1] upon timeout otherwise.
3453                 assert_eq!(node_txn.len(), 1);
3454                 node_txn.remove(0)
3455         };
3456
3457         mine_transaction(&nodes[1], &tx);
3458
3459         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3460         check_closed_broadcast!(nodes[1], true);
3461         check_added_monitors!(nodes[1], 1);
3462         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
3463
3464         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3465         {
3466                 get_monitor!(nodes[2], payment_event.commitment_msg.channel_id)
3467                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &LowerBoundedFeeEstimator::new(node_cfgs[2].fee_estimator), &node_cfgs[2].logger);
3468         }
3469         mine_transaction(&nodes[2], &tx);
3470         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3471         assert_eq!(node_txn.len(), 1);
3472         assert_eq!(node_txn[0].input.len(), 1);
3473         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3474         assert_eq!(node_txn[0].lock_time.0, 0); // Must be an HTLC-Success
3475         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3476
3477         check_spends!(node_txn[0], tx);
3478 }
3479
3480 #[test]
3481 fn test_dup_events_on_peer_disconnect() {
3482         // Test that if we receive a duplicative update_fulfill_htlc message after a reconnect we do
3483         // not generate a corresponding duplicative PaymentSent event. This did not use to be the case
3484         // as we used to generate the event immediately upon receipt of the payment preimage in the
3485         // update_fulfill_htlc message.
3486
3487         let chanmon_cfgs = create_chanmon_cfgs(2);
3488         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3489         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3490         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3491         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3492
3493         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
3494
3495         nodes[1].node.claim_funds(payment_preimage);
3496         expect_payment_claimed!(nodes[1], payment_hash, 1_000_000);
3497         check_added_monitors!(nodes[1], 1);
3498         let claim_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3499         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &claim_msgs.update_fulfill_htlcs[0]);
3500         expect_payment_sent_without_paths!(nodes[0], payment_preimage);
3501
3502         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3503         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3504
3505         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3506         expect_payment_path_successful!(nodes[0]);
3507 }
3508
3509 #[test]
3510 fn test_peer_disconnected_before_funding_broadcasted() {
3511         // Test that channels are closed with `ClosureReason::DisconnectedPeer` if the peer disconnects
3512         // before the funding transaction has been broadcasted.
3513         let chanmon_cfgs = create_chanmon_cfgs(2);
3514         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3515         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3516         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3517
3518         // Open a channel between `nodes[0]` and `nodes[1]`, for which the funding transaction is never
3519         // broadcasted, even though it's created by `nodes[0]`.
3520         let expected_temporary_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
3521         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
3522         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
3523         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
3524         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
3525
3526         let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
3527         assert_eq!(temporary_channel_id, expected_temporary_channel_id);
3528
3529         assert!(nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).is_ok());
3530
3531         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
3532         assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
3533
3534         // Even though the funding transaction is created by `nodes[0]`, the `FundingCreated` msg is
3535         // never sent to `nodes[1]`, and therefore the tx is never signed by either party nor
3536         // broadcasted.
3537         {
3538                 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
3539         }
3540
3541         // Ensure that the channel is closed with `ClosureReason::DisconnectedPeer` when the peers are
3542         // disconnected before the funding transaction was broadcasted.
3543         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3544         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3545
3546         check_closed_event!(nodes[0], 1, ClosureReason::DisconnectedPeer);
3547         check_closed_event!(nodes[1], 1, ClosureReason::DisconnectedPeer);
3548 }
3549
3550 #[test]
3551 fn test_simple_peer_disconnect() {
3552         // Test that we can reconnect when there are no lost messages
3553         let chanmon_cfgs = create_chanmon_cfgs(3);
3554         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3555         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3556         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3557         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3558         create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3559
3560         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3561         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3562         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3563
3564         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3565         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3566         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3567         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3568
3569         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3570         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3571         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3572
3573         let (payment_preimage_3, payment_hash_3, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000);
3574         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3575         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3576         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3577
3578         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3579         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3580
3581         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3582         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_hash_5);
3583
3584         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3585         {
3586                 let events = nodes[0].node.get_and_clear_pending_events();
3587                 assert_eq!(events.len(), 3);
3588                 match events[0] {
3589                         Event::PaymentSent { payment_preimage, payment_hash, .. } => {
3590                                 assert_eq!(payment_preimage, payment_preimage_3);
3591                                 assert_eq!(payment_hash, payment_hash_3);
3592                         },
3593                         _ => panic!("Unexpected event"),
3594                 }
3595                 match events[1] {
3596                         Event::PaymentPathFailed { payment_hash, payment_failed_permanently, .. } => {
3597                                 assert_eq!(payment_hash, payment_hash_5);
3598                                 assert!(payment_failed_permanently);
3599                         },
3600                         _ => panic!("Unexpected event"),
3601                 }
3602                 match events[2] {
3603                         Event::PaymentPathSuccessful { .. } => {},
3604                         _ => panic!("Unexpected event"),
3605                 }
3606         }
3607
3608         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3609         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3610 }
3611
3612 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken_lnd: bool) {
3613         // Test that we can reconnect when in-flight HTLC updates get dropped
3614         let chanmon_cfgs = create_chanmon_cfgs(2);
3615         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3616         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3617         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3618
3619         let mut as_channel_ready = None;
3620         if messages_delivered == 0 {
3621                 let (channel_ready, _, _) = create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3622                 as_channel_ready = Some(channel_ready);
3623                 // nodes[1] doesn't receive the channel_ready message (it'll be re-sent on reconnect)
3624                 // Note that we store it so that if we're running with `simulate_broken_lnd` we can deliver
3625                 // it before the channel_reestablish message.
3626         } else {
3627                 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3628         }
3629
3630         let (route, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1_000_000);
3631
3632         let payment_event = {
3633                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
3634                 check_added_monitors!(nodes[0], 1);
3635
3636                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3637                 assert_eq!(events.len(), 1);
3638                 SendEvent::from_event(events.remove(0))
3639         };
3640         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3641
3642         if messages_delivered < 2 {
3643                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3644         } else {
3645                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3646                 if messages_delivered >= 3 {
3647                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3648                         check_added_monitors!(nodes[1], 1);
3649                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3650
3651                         if messages_delivered >= 4 {
3652                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3653                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3654                                 check_added_monitors!(nodes[0], 1);
3655
3656                                 if messages_delivered >= 5 {
3657                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3658                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3659                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3660                                         check_added_monitors!(nodes[0], 1);
3661
3662                                         if messages_delivered >= 6 {
3663                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3664                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3665                                                 check_added_monitors!(nodes[1], 1);
3666                                         }
3667                                 }
3668                         }
3669                 }
3670         }
3671
3672         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3673         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3674         if messages_delivered < 3 {
3675                 if simulate_broken_lnd {
3676                         // lnd has a long-standing bug where they send a channel_ready prior to a
3677                         // channel_reestablish if you reconnect prior to channel_ready time.
3678                         //
3679                         // Here we simulate that behavior, delivering a channel_ready immediately on
3680                         // reconnect. Note that we don't bother skipping the now-duplicate channel_ready sent
3681                         // in `reconnect_nodes` but we currently don't fail based on that.
3682                         //
3683                         // See-also <https://github.com/lightningnetwork/lnd/issues/4006>
3684                         nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_channel_ready.as_ref().unwrap().0);
3685                 }
3686                 // Even if the channel_ready messages get exchanged, as long as nothing further was
3687                 // received on either side, both sides will need to resend them.
3688                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3689         } else if messages_delivered == 3 {
3690                 // nodes[0] still wants its RAA + commitment_signed
3691                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3692         } else if messages_delivered == 4 {
3693                 // nodes[0] still wants its commitment_signed
3694                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3695         } else if messages_delivered == 5 {
3696                 // nodes[1] still wants its final RAA
3697                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3698         } else if messages_delivered == 6 {
3699                 // Everything was delivered...
3700                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3701         }
3702
3703         let events_1 = nodes[1].node.get_and_clear_pending_events();
3704         if messages_delivered == 0 {
3705                 assert_eq!(events_1.len(), 2);
3706                 match events_1[0] {
3707                         Event::ChannelReady { .. } => { },
3708                         _ => panic!("Unexpected event"),
3709                 };
3710                 match events_1[1] {
3711                         Event::PendingHTLCsForwardable { .. } => { },
3712                         _ => panic!("Unexpected event"),
3713                 };
3714         } else {
3715                 assert_eq!(events_1.len(), 1);
3716                 match events_1[0] {
3717                         Event::PendingHTLCsForwardable { .. } => { },
3718                         _ => panic!("Unexpected event"),
3719                 };
3720         }
3721
3722         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3723         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3724         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3725
3726         nodes[1].node.process_pending_htlc_forwards();
3727
3728         let events_2 = nodes[1].node.get_and_clear_pending_events();
3729         assert_eq!(events_2.len(), 1);
3730         match events_2[0] {
3731                 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
3732                         assert_eq!(payment_hash_1, *payment_hash);
3733                         assert_eq!(amount_msat, 1_000_000);
3734                         match &purpose {
3735                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
3736                                         assert!(payment_preimage.is_none());
3737                                         assert_eq!(payment_secret_1, *payment_secret);
3738                                 },
3739                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
3740                         }
3741                 },
3742                 _ => panic!("Unexpected event"),
3743         }
3744
3745         nodes[1].node.claim_funds(payment_preimage_1);
3746         check_added_monitors!(nodes[1], 1);
3747         expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
3748
3749         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3750         assert_eq!(events_3.len(), 1);
3751         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3752                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3753                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3754                         assert!(updates.update_add_htlcs.is_empty());
3755                         assert!(updates.update_fail_htlcs.is_empty());
3756                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3757                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3758                         assert!(updates.update_fee.is_none());
3759                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3760                 },
3761                 _ => panic!("Unexpected event"),
3762         };
3763
3764         if messages_delivered >= 1 {
3765                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3766
3767                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3768                 assert_eq!(events_4.len(), 1);
3769                 match events_4[0] {
3770                         Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
3771                                 assert_eq!(payment_preimage_1, *payment_preimage);
3772                                 assert_eq!(payment_hash_1, *payment_hash);
3773                         },
3774                         _ => panic!("Unexpected event"),
3775                 }
3776
3777                 if messages_delivered >= 2 {
3778                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3779                         check_added_monitors!(nodes[0], 1);
3780                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3781
3782                         if messages_delivered >= 3 {
3783                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3784                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3785                                 check_added_monitors!(nodes[1], 1);
3786
3787                                 if messages_delivered >= 4 {
3788                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3789                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3790                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3791                                         check_added_monitors!(nodes[1], 1);
3792
3793                                         if messages_delivered >= 5 {
3794                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3795                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3796                                                 check_added_monitors!(nodes[0], 1);
3797                                         }
3798                                 }
3799                         }
3800                 }
3801         }
3802
3803         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3804         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3805         if messages_delivered < 2 {
3806                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3807                 if messages_delivered < 1 {
3808                         expect_payment_sent!(nodes[0], payment_preimage_1);
3809                 } else {
3810                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3811                 }
3812         } else if messages_delivered == 2 {
3813                 // nodes[0] still wants its RAA + commitment_signed
3814                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3815         } else if messages_delivered == 3 {
3816                 // nodes[0] still wants its commitment_signed
3817                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3818         } else if messages_delivered == 4 {
3819                 // nodes[1] still wants its final RAA
3820                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3821         } else if messages_delivered == 5 {
3822                 // Everything was delivered...
3823                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3824         }
3825
3826         if messages_delivered == 1 || messages_delivered == 2 {
3827                 expect_payment_path_successful!(nodes[0]);
3828         }
3829
3830         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3831         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3832         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3833
3834         if messages_delivered > 2 {
3835                 expect_payment_path_successful!(nodes[0]);
3836         }
3837
3838         // Channel should still work fine...
3839         let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
3840         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3841         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3842 }
3843
3844 #[test]
3845 fn test_drop_messages_peer_disconnect_a() {
3846         do_test_drop_messages_peer_disconnect(0, true);
3847         do_test_drop_messages_peer_disconnect(0, false);
3848         do_test_drop_messages_peer_disconnect(1, false);
3849         do_test_drop_messages_peer_disconnect(2, false);
3850 }
3851
3852 #[test]
3853 fn test_drop_messages_peer_disconnect_b() {
3854         do_test_drop_messages_peer_disconnect(3, false);
3855         do_test_drop_messages_peer_disconnect(4, false);
3856         do_test_drop_messages_peer_disconnect(5, false);
3857         do_test_drop_messages_peer_disconnect(6, false);
3858 }
3859
3860 #[test]
3861 fn test_channel_ready_without_best_block_updated() {
3862         // Previously, if we were offline when a funding transaction was locked in, and then we came
3863         // back online, calling best_block_updated once followed by transactions_confirmed, we'd not
3864         // generate a channel_ready until a later best_block_updated. This tests that we generate the
3865         // channel_ready immediately instead.
3866         let chanmon_cfgs = create_chanmon_cfgs(2);
3867         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3868         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3869         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3870         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
3871
3872         let funding_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 1_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3873
3874         let conf_height = nodes[0].best_block_info().1 + 1;
3875         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
3876         let block_txn = [funding_tx];
3877         let conf_txn: Vec<_> = block_txn.iter().enumerate().collect();
3878         let conf_block_header = nodes[0].get_block_header(conf_height);
3879         nodes[0].node.transactions_confirmed(&conf_block_header, &conf_txn[..], conf_height);
3880
3881         // Ensure nodes[0] generates a channel_ready after the transactions_confirmed
3882         let as_channel_ready = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
3883         nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_channel_ready);
3884 }
3885
3886 #[test]
3887 fn test_drop_messages_peer_disconnect_dual_htlc() {
3888         // Test that we can handle reconnecting when both sides of a channel have pending
3889         // commitment_updates when we disconnect.
3890         let chanmon_cfgs = create_chanmon_cfgs(2);
3891         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3892         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3893         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3894         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
3895
3896         let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
3897
3898         // Now try to send a second payment which will fail to send
3899         let (route, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
3900         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
3901         check_added_monitors!(nodes[0], 1);
3902
3903         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3904         assert_eq!(events_1.len(), 1);
3905         match events_1[0] {
3906                 MessageSendEvent::UpdateHTLCs { .. } => {},
3907                 _ => panic!("Unexpected event"),
3908         }
3909
3910         nodes[1].node.claim_funds(payment_preimage_1);
3911         expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
3912         check_added_monitors!(nodes[1], 1);
3913
3914         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3915         assert_eq!(events_2.len(), 1);
3916         match events_2[0] {
3917                 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 } } => {
3918                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3919                         assert!(update_add_htlcs.is_empty());
3920                         assert_eq!(update_fulfill_htlcs.len(), 1);
3921                         assert!(update_fail_htlcs.is_empty());
3922                         assert!(update_fail_malformed_htlcs.is_empty());
3923                         assert!(update_fee.is_none());
3924
3925                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3926                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3927                         assert_eq!(events_3.len(), 1);
3928                         match events_3[0] {
3929                                 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
3930                                         assert_eq!(*payment_preimage, payment_preimage_1);
3931                                         assert_eq!(*payment_hash, payment_hash_1);
3932                                 },
3933                                 _ => panic!("Unexpected event"),
3934                         }
3935
3936                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3937                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3938                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3939                         check_added_monitors!(nodes[0], 1);
3940                 },
3941                 _ => panic!("Unexpected event"),
3942         }
3943
3944         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3945         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3946
3947         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
3948         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3949         assert_eq!(reestablish_1.len(), 1);
3950         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
3951         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3952         assert_eq!(reestablish_2.len(), 1);
3953
3954         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3955         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3956         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3957         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3958
3959         assert!(as_resp.0.is_none());
3960         assert!(bs_resp.0.is_none());
3961
3962         assert!(bs_resp.1.is_none());
3963         assert!(bs_resp.2.is_none());
3964
3965         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3966
3967         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3968         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3969         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3970         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3971         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3972         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3973         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3974         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3975         // No commitment_signed so get_event_msg's assert(len == 1) passes
3976         check_added_monitors!(nodes[1], 1);
3977
3978         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3979         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3980         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3981         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3982         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3983         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3984         assert!(bs_second_commitment_signed.update_fee.is_none());
3985         check_added_monitors!(nodes[1], 1);
3986
3987         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3988         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3989         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3990         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3991         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3992         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3993         assert!(as_commitment_signed.update_fee.is_none());
3994         check_added_monitors!(nodes[0], 1);
3995
3996         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3997         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3998         // No commitment_signed so get_event_msg's assert(len == 1) passes
3999         check_added_monitors!(nodes[0], 1);
4000
4001         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4002         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4003         // No commitment_signed so get_event_msg's assert(len == 1) passes
4004         check_added_monitors!(nodes[1], 1);
4005
4006         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4007         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4008         check_added_monitors!(nodes[1], 1);
4009
4010         expect_pending_htlcs_forwardable!(nodes[1]);
4011
4012         let events_5 = nodes[1].node.get_and_clear_pending_events();
4013         assert_eq!(events_5.len(), 1);
4014         match events_5[0] {
4015                 Event::PaymentReceived { ref payment_hash, ref purpose, .. } => {
4016                         assert_eq!(payment_hash_2, *payment_hash);
4017                         match &purpose {
4018                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
4019                                         assert!(payment_preimage.is_none());
4020                                         assert_eq!(payment_secret_2, *payment_secret);
4021                                 },
4022                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
4023                         }
4024                 },
4025                 _ => panic!("Unexpected event"),
4026         }
4027
4028         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4029         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4030         check_added_monitors!(nodes[0], 1);
4031
4032         expect_payment_path_successful!(nodes[0]);
4033         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4034 }
4035
4036 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4037         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4038         // to avoid our counterparty failing the channel.
4039         let chanmon_cfgs = create_chanmon_cfgs(2);
4040         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4041         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4042         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4043
4044         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4045
4046         let our_payment_hash = if send_partial_mpp {
4047                 let (route, our_payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100000);
4048                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4049                 // indicates there are more HTLCs coming.
4050                 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.
4051                 let payment_id = PaymentId([42; 32]);
4052                 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash, Some(payment_secret), payment_id, &route).unwrap();
4053                 nodes[0].node.send_payment_along_path(&route.paths[0], &route.payment_params, &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
4054                 check_added_monitors!(nodes[0], 1);
4055                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4056                 assert_eq!(events.len(), 1);
4057                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4058                 // hop should *not* yet generate any PaymentReceived event(s).
4059                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
4060                 our_payment_hash
4061         } else {
4062                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4063         };
4064
4065         let mut block = Block {
4066                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
4067                 txdata: vec![],
4068         };
4069         connect_block(&nodes[0], &block);
4070         connect_block(&nodes[1], &block);
4071         let block_count = TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS;
4072         for _ in CHAN_CONFIRM_DEPTH + 2..block_count {
4073                 block.header.prev_blockhash = block.block_hash();
4074                 connect_block(&nodes[0], &block);
4075                 connect_block(&nodes[1], &block);
4076         }
4077
4078         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
4079
4080         check_added_monitors!(nodes[1], 1);
4081         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4082         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4083         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4084         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4085         assert!(htlc_timeout_updates.update_fee.is_none());
4086
4087         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4088         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4089         // 100_000 msat as u64, followed by the height at which we failed back above
4090         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4091         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(block_count - 1));
4092         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4093 }
4094
4095 #[test]
4096 fn test_htlc_timeout() {
4097         do_test_htlc_timeout(true);
4098         do_test_htlc_timeout(false);
4099 }
4100
4101 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4102         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4103         let chanmon_cfgs = create_chanmon_cfgs(3);
4104         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4105         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4106         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4107         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4108         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4109
4110         // Make sure all nodes are at the same starting height
4111         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4112         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4113         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4114
4115         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4116         let (route, first_payment_hash, _, first_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[2], 100000);
4117         {
4118                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret), PaymentId(first_payment_hash.0)).unwrap();
4119         }
4120         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4121         check_added_monitors!(nodes[1], 1);
4122
4123         // Now attempt to route a second payment, which should be placed in the holding cell
4124         let sending_node = if forwarded_htlc { &nodes[0] } else { &nodes[1] };
4125         let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(sending_node, nodes[2], 100000);
4126         sending_node.node.send_payment(&route, second_payment_hash, &Some(second_payment_secret), PaymentId(second_payment_hash.0)).unwrap();
4127         if forwarded_htlc {
4128                 check_added_monitors!(nodes[0], 1);
4129                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4130                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4131                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4132                 expect_pending_htlcs_forwardable!(nodes[1]);
4133         }
4134         check_added_monitors!(nodes[1], 0);
4135
4136         connect_blocks(&nodes[1], TEST_FINAL_CLTV - LATENCY_GRACE_PERIOD_BLOCKS);
4137         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4138         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4139         connect_blocks(&nodes[1], 1);
4140
4141         if forwarded_htlc {
4142                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
4143                 check_added_monitors!(nodes[1], 1);
4144                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4145                 assert_eq!(fail_commit.len(), 1);
4146                 match fail_commit[0] {
4147                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4148                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4149                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4150                         },
4151                         _ => unreachable!(),
4152                 }
4153                 expect_payment_failed_with_update!(nodes[0], second_payment_hash, false, chan_2.0.contents.short_channel_id, false);
4154         } else {
4155                 expect_payment_failed!(nodes[1], second_payment_hash, false);
4156         }
4157 }
4158
4159 #[test]
4160 fn test_holding_cell_htlc_add_timeouts() {
4161         do_test_holding_cell_htlc_add_timeouts(false);
4162         do_test_holding_cell_htlc_add_timeouts(true);
4163 }
4164
4165 macro_rules! check_spendable_outputs {
4166         ($node: expr, $keysinterface: expr) => {
4167                 {
4168                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4169                         let mut txn = Vec::new();
4170                         let mut all_outputs = Vec::new();
4171                         let secp_ctx = Secp256k1::new();
4172                         for event in events.drain(..) {
4173                                 match event {
4174                                         Event::SpendableOutputs { mut outputs } => {
4175                                                 for outp in outputs.drain(..) {
4176                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4177                                                         all_outputs.push(outp);
4178                                                 }
4179                                         },
4180                                         _ => panic!("Unexpected event"),
4181                                 };
4182                         }
4183                         if all_outputs.len() > 1 {
4184                                 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) {
4185                                         txn.push(tx);
4186                                 }
4187                         }
4188                         txn
4189                 }
4190         }
4191 }
4192
4193 #[test]
4194 fn test_claim_sizeable_push_msat() {
4195         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4196         let chanmon_cfgs = create_chanmon_cfgs(2);
4197         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4198         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4199         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4200
4201         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 98_000_000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4202         nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
4203         check_closed_broadcast!(nodes[1], true);
4204         check_added_monitors!(nodes[1], 1);
4205         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
4206         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4207         assert_eq!(node_txn.len(), 1);
4208         check_spends!(node_txn[0], chan.3);
4209         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
4210
4211         mine_transaction(&nodes[1], &node_txn[0]);
4212         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4213
4214         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4215         assert_eq!(spend_txn.len(), 1);
4216         assert_eq!(spend_txn[0].input.len(), 1);
4217         check_spends!(spend_txn[0], node_txn[0]);
4218         assert_eq!(spend_txn[0].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
4219 }
4220
4221 #[test]
4222 fn test_claim_on_remote_sizeable_push_msat() {
4223         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4224         // to_remote output is encumbered by a P2WPKH
4225         let chanmon_cfgs = create_chanmon_cfgs(2);
4226         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4227         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4228         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4229
4230         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 98_000_000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4231         nodes[0].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[1].node.get_our_node_id()).unwrap();
4232         check_closed_broadcast!(nodes[0], true);
4233         check_added_monitors!(nodes[0], 1);
4234         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
4235
4236         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4237         assert_eq!(node_txn.len(), 1);
4238         check_spends!(node_txn[0], chan.3);
4239         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
4240
4241         mine_transaction(&nodes[1], &node_txn[0]);
4242         check_closed_broadcast!(nodes[1], true);
4243         check_added_monitors!(nodes[1], 1);
4244         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4245         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4246
4247         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4248         assert_eq!(spend_txn.len(), 1);
4249         check_spends!(spend_txn[0], node_txn[0]);
4250 }
4251
4252 #[test]
4253 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4254         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4255         // to_remote output is encumbered by a P2WPKH
4256
4257         let chanmon_cfgs = create_chanmon_cfgs(2);
4258         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4259         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4260         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4261
4262         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4263         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4264         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4265         assert_eq!(revoked_local_txn[0].input.len(), 1);
4266         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4267
4268         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4269         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4270         check_closed_broadcast!(nodes[1], true);
4271         check_added_monitors!(nodes[1], 1);
4272         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4273
4274         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4275         mine_transaction(&nodes[1], &node_txn[0]);
4276         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4277
4278         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4279         assert_eq!(spend_txn.len(), 3);
4280         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4281         check_spends!(spend_txn[1], node_txn[0]);
4282         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4283 }
4284
4285 #[test]
4286 fn test_static_spendable_outputs_preimage_tx() {
4287         let chanmon_cfgs = create_chanmon_cfgs(2);
4288         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4289         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4290         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4291
4292         // Create some initial channels
4293         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4294
4295         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 3_000_000);
4296
4297         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4298         assert_eq!(commitment_tx[0].input.len(), 1);
4299         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4300
4301         // Settle A's commitment tx on B's chain
4302         nodes[1].node.claim_funds(payment_preimage);
4303         expect_payment_claimed!(nodes[1], payment_hash, 3_000_000);
4304         check_added_monitors!(nodes[1], 1);
4305         mine_transaction(&nodes[1], &commitment_tx[0]);
4306         check_added_monitors!(nodes[1], 1);
4307         let events = nodes[1].node.get_and_clear_pending_msg_events();
4308         match events[0] {
4309                 MessageSendEvent::UpdateHTLCs { .. } => {},
4310                 _ => panic!("Unexpected event"),
4311         }
4312         match events[1] {
4313                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4314                 _ => panic!("Unexepected event"),
4315         }
4316
4317         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4318         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4319         assert_eq!(node_txn.len(), 3);
4320         check_spends!(node_txn[0], commitment_tx[0]);
4321         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4322         check_spends!(node_txn[1], chan_1.3);
4323         check_spends!(node_txn[2], node_txn[1]);
4324
4325         mine_transaction(&nodes[1], &node_txn[0]);
4326         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4327         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4328
4329         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4330         assert_eq!(spend_txn.len(), 1);
4331         check_spends!(spend_txn[0], node_txn[0]);
4332 }
4333
4334 #[test]
4335 fn test_static_spendable_outputs_timeout_tx() {
4336         let chanmon_cfgs = create_chanmon_cfgs(2);
4337         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4338         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4339         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4340
4341         // Create some initial channels
4342         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4343
4344         // Rebalance the network a bit by relaying one payment through all the channels ...
4345         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4346
4347         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4348
4349         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4350         assert_eq!(commitment_tx[0].input.len(), 1);
4351         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4352
4353         // Settle A's commitment tx on B' chain
4354         mine_transaction(&nodes[1], &commitment_tx[0]);
4355         check_added_monitors!(nodes[1], 1);
4356         let events = nodes[1].node.get_and_clear_pending_msg_events();
4357         match events[0] {
4358                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4359                 _ => panic!("Unexpected event"),
4360         }
4361         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4362
4363         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4364         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4365         assert_eq!(node_txn.len(), 2); // ChannelManager : 1 local commitent tx, ChannelMonitor: timeout tx
4366         check_spends!(node_txn[0], chan_1.3.clone());
4367         check_spends!(node_txn[1],  commitment_tx[0].clone());
4368         assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4369
4370         mine_transaction(&nodes[1], &node_txn[1]);
4371         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4372         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4373         expect_payment_failed!(nodes[1], our_payment_hash, false);
4374
4375         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4376         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4377         check_spends!(spend_txn[0], commitment_tx[0]);
4378         check_spends!(spend_txn[1], node_txn[1]);
4379         check_spends!(spend_txn[2], node_txn[1], commitment_tx[0]); // All outputs
4380 }
4381
4382 #[test]
4383 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4384         let chanmon_cfgs = create_chanmon_cfgs(2);
4385         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4386         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4387         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4388
4389         // Create some initial channels
4390         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4391
4392         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4393         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4394         assert_eq!(revoked_local_txn[0].input.len(), 1);
4395         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4396
4397         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4398
4399         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4400         check_closed_broadcast!(nodes[1], true);
4401         check_added_monitors!(nodes[1], 1);
4402         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4403
4404         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4405         assert_eq!(node_txn.len(), 2);
4406         assert_eq!(node_txn[0].input.len(), 2);
4407         check_spends!(node_txn[0], revoked_local_txn[0]);
4408
4409         mine_transaction(&nodes[1], &node_txn[0]);
4410         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4411
4412         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4413         assert_eq!(spend_txn.len(), 1);
4414         check_spends!(spend_txn[0], node_txn[0]);
4415 }
4416
4417 #[test]
4418 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4419         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4420         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4421         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4422         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4423         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4424
4425         // Create some initial channels
4426         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4427
4428         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4429         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4430         assert_eq!(revoked_local_txn[0].input.len(), 1);
4431         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4432
4433         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4434
4435         // A will generate HTLC-Timeout from revoked commitment tx
4436         mine_transaction(&nodes[0], &revoked_local_txn[0]);
4437         check_closed_broadcast!(nodes[0], true);
4438         check_added_monitors!(nodes[0], 1);
4439         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
4440         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
4441
4442         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4443         assert_eq!(revoked_htlc_txn.len(), 2);
4444         check_spends!(revoked_htlc_txn[0], chan_1.3);
4445         assert_eq!(revoked_htlc_txn[1].input.len(), 1);
4446         assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4447         check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
4448         assert_ne!(revoked_htlc_txn[1].lock_time.0, 0); // HTLC-Timeout
4449
4450         // B will generate justice tx from A's revoked commitment/HTLC tx
4451         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
4452         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[1].clone()] });
4453         check_closed_broadcast!(nodes[1], true);
4454         check_added_monitors!(nodes[1], 1);
4455         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4456
4457         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4458         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4459         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4460         // including the one already spent by revoked_htlc_txn[1]. That's OK, we'll spend with valid
4461         // transactions next...
4462         assert_eq!(node_txn[0].input.len(), 3);
4463         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[1]);
4464
4465         assert_eq!(node_txn[1].input.len(), 2);
4466         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[1]);
4467         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[1].txid() {
4468                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4469         } else {
4470                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[1].txid());
4471                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[1].input[0].previous_output);
4472         }
4473
4474         assert_eq!(node_txn[2].input.len(), 1);
4475         check_spends!(node_txn[2], chan_1.3);
4476
4477         mine_transaction(&nodes[1], &node_txn[1]);
4478         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4479
4480         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4481         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4482         assert_eq!(spend_txn.len(), 1);
4483         assert_eq!(spend_txn[0].input.len(), 1);
4484         check_spends!(spend_txn[0], node_txn[1]);
4485 }
4486
4487 #[test]
4488 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4489         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4490         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4491         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4492         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4493         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4494
4495         // Create some initial channels
4496         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4497
4498         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4499         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4500         assert_eq!(revoked_local_txn[0].input.len(), 1);
4501         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4502
4503         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4504         assert_eq!(revoked_local_txn[0].output.len(), 2);
4505
4506         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4507
4508         // B will generate HTLC-Success from revoked commitment tx
4509         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4510         check_closed_broadcast!(nodes[1], true);
4511         check_added_monitors!(nodes[1], 1);
4512         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4513         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4514
4515         assert_eq!(revoked_htlc_txn.len(), 2);
4516         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4517         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4518         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4519
4520         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4521         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4522         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4523
4524         // A will generate justice tx from B's revoked commitment/HTLC tx
4525         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
4526         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4527         check_closed_broadcast!(nodes[0], true);
4528         check_added_monitors!(nodes[0], 1);
4529         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
4530
4531         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4532         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4533
4534         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4535         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4536         // transactions next...
4537         assert_eq!(node_txn[0].input.len(), 2);
4538         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4539         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4540                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4541         } else {
4542                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4543                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4544         }
4545
4546         assert_eq!(node_txn[1].input.len(), 1);
4547         check_spends!(node_txn[1], revoked_htlc_txn[0]);
4548
4549         check_spends!(node_txn[2], chan_1.3);
4550
4551         mine_transaction(&nodes[0], &node_txn[1]);
4552         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
4553
4554         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4555         // didn't try to generate any new transactions.
4556
4557         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4558         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
4559         assert_eq!(spend_txn.len(), 3);
4560         assert_eq!(spend_txn[0].input.len(), 1);
4561         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4562         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4563         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
4564         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
4565 }
4566
4567 #[test]
4568 fn test_onchain_to_onchain_claim() {
4569         // Test that in case of channel closure, we detect the state of output and claim HTLC
4570         // on downstream peer's remote commitment tx.
4571         // First, have C claim an HTLC against its own latest commitment transaction.
4572         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4573         // channel.
4574         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4575         // gets broadcast.
4576
4577         let chanmon_cfgs = create_chanmon_cfgs(3);
4578         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4579         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4580         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4581
4582         // Create some initial channels
4583         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4584         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4585
4586         // Ensure all nodes are at the same height
4587         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
4588         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
4589         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
4590         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
4591
4592         // Rebalance the network a bit by relaying one payment through all the channels ...
4593         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4594         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
4595
4596         let (payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
4597         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4598         check_spends!(commitment_tx[0], chan_2.3);
4599         nodes[2].node.claim_funds(payment_preimage);
4600         expect_payment_claimed!(nodes[2], payment_hash, 3_000_000);
4601         check_added_monitors!(nodes[2], 1);
4602         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4603         assert!(updates.update_add_htlcs.is_empty());
4604         assert!(updates.update_fail_htlcs.is_empty());
4605         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4606         assert!(updates.update_fail_malformed_htlcs.is_empty());
4607
4608         mine_transaction(&nodes[2], &commitment_tx[0]);
4609         check_closed_broadcast!(nodes[2], true);
4610         check_added_monitors!(nodes[2], 1);
4611         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
4612
4613         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4614         assert_eq!(c_txn.len(), 3);
4615         assert_eq!(c_txn[0], c_txn[2]);
4616         assert_eq!(commitment_tx[0], c_txn[1]);
4617         check_spends!(c_txn[1], chan_2.3);
4618         check_spends!(c_txn[2], c_txn[1]);
4619         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4620         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4621         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4622         assert_eq!(c_txn[0].lock_time.0, 0); // Success tx
4623
4624         // 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
4625         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
4626         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
4627         check_added_monitors!(nodes[1], 1);
4628         let events = nodes[1].node.get_and_clear_pending_events();
4629         assert_eq!(events.len(), 2);
4630         match events[0] {
4631                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
4632                 _ => panic!("Unexpected event"),
4633         }
4634         match events[1] {
4635                 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
4636                         assert_eq!(fee_earned_msat, Some(1000));
4637                         assert_eq!(prev_channel_id, Some(chan_1.2));
4638                         assert_eq!(claim_from_onchain_tx, true);
4639                         assert_eq!(next_channel_id, Some(chan_2.2));
4640                 },
4641                 _ => panic!("Unexpected event"),
4642         }
4643         {
4644                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4645                 // ChannelMonitor: claim tx
4646                 assert_eq!(b_txn.len(), 1);
4647                 check_spends!(b_txn[0], chan_2.3); // B local commitment tx, issued by ChannelManager
4648                 b_txn.clear();
4649         }
4650         check_added_monitors!(nodes[1], 1);
4651         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4652         assert_eq!(msg_events.len(), 3);
4653         match msg_events[0] {
4654                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4655                 _ => panic!("Unexpected event"),
4656         }
4657         match msg_events[1] {
4658                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
4659                 _ => panic!("Unexpected event"),
4660         }
4661         match msg_events[2] {
4662                 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, .. } } => {
4663                         assert!(update_add_htlcs.is_empty());
4664                         assert!(update_fail_htlcs.is_empty());
4665                         assert_eq!(update_fulfill_htlcs.len(), 1);
4666                         assert!(update_fail_malformed_htlcs.is_empty());
4667                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4668                 },
4669                 _ => panic!("Unexpected event"),
4670         };
4671         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4672         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4673         mine_transaction(&nodes[1], &commitment_tx[0]);
4674         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4675         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4676         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4677         assert_eq!(b_txn.len(), 3);
4678         check_spends!(b_txn[1], chan_1.3);
4679         check_spends!(b_txn[2], b_txn[1]);
4680         check_spends!(b_txn[0], commitment_tx[0]);
4681         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4682         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4683         assert_eq!(b_txn[0].lock_time.0, 0); // Success tx
4684
4685         check_closed_broadcast!(nodes[1], true);
4686         check_added_monitors!(nodes[1], 1);
4687 }
4688
4689 #[test]
4690 fn test_duplicate_payment_hash_one_failure_one_success() {
4691         // Topology : A --> B --> C --> D
4692         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4693         // Note that because C will refuse to generate two payment secrets for the same payment hash,
4694         // we forward one of the payments onwards to D.
4695         let chanmon_cfgs = create_chanmon_cfgs(4);
4696         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4697         // When this test was written, the default base fee floated based on the HTLC count.
4698         // It is now fixed, so we simply set the fee to the expected value here.
4699         let mut config = test_default_channel_config();
4700         config.channel_config.forwarding_fee_base_msat = 196;
4701         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
4702                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
4703         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4704
4705         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4706         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4707         create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4708
4709         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
4710         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
4711         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
4712         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
4713         connect_blocks(&nodes[3], node_max_height - nodes[3].best_block_info().1);
4714
4715         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 900_000);
4716
4717         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200).unwrap();
4718         // We reduce the final CLTV here by a somewhat arbitrary constant to keep it under the one-byte
4719         // script push size limit so that the below script length checks match
4720         // ACCEPTED_HTLC_SCRIPT_WEIGHT.
4721         let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id())
4722                 .with_features(channelmanager::provided_invoice_features());
4723         let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[3], payment_params, 900000, TEST_FINAL_CLTV - 40);
4724         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
4725
4726         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
4727         assert_eq!(commitment_txn[0].input.len(), 1);
4728         check_spends!(commitment_txn[0], chan_2.3);
4729
4730         mine_transaction(&nodes[1], &commitment_txn[0]);
4731         check_closed_broadcast!(nodes[1], true);
4732         check_added_monitors!(nodes[1], 1);
4733         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4734         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 40 + MIN_CLTV_EXPIRY_DELTA as u32 - 1); // Confirm blocks until the HTLC expires
4735
4736         let htlc_timeout_tx;
4737         { // Extract one of the two HTLC-Timeout transaction
4738                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4739                 // ChannelMonitor: timeout tx * 2-or-3, ChannelManager: local commitment tx
4740                 assert!(node_txn.len() == 4 || node_txn.len() == 3);
4741                 check_spends!(node_txn[0], chan_2.3);
4742
4743                 check_spends!(node_txn[1], commitment_txn[0]);
4744                 assert_eq!(node_txn[1].input.len(), 1);
4745
4746                 if node_txn.len() > 3 {
4747                         check_spends!(node_txn[2], commitment_txn[0]);
4748                         assert_eq!(node_txn[2].input.len(), 1);
4749                         assert_eq!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
4750
4751                         check_spends!(node_txn[3], commitment_txn[0]);
4752                         assert_ne!(node_txn[1].input[0].previous_output, node_txn[3].input[0].previous_output);
4753                 } else {
4754                         check_spends!(node_txn[2], commitment_txn[0]);
4755                         assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
4756                 }
4757
4758                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4759                 assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4760                 if node_txn.len() > 3 {
4761                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4762                 }
4763                 htlc_timeout_tx = node_txn[1].clone();
4764         }
4765
4766         nodes[2].node.claim_funds(our_payment_preimage);
4767         expect_payment_claimed!(nodes[2], duplicate_payment_hash, 900_000);
4768
4769         mine_transaction(&nodes[2], &commitment_txn[0]);
4770         check_added_monitors!(nodes[2], 2);
4771         check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
4772         let events = nodes[2].node.get_and_clear_pending_msg_events();
4773         match events[0] {
4774                 MessageSendEvent::UpdateHTLCs { .. } => {},
4775                 _ => panic!("Unexpected event"),
4776         }
4777         match events[1] {
4778                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4779                 _ => panic!("Unexepected event"),
4780         }
4781         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4782         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)
4783         check_spends!(htlc_success_txn[0], commitment_txn[0]);
4784         check_spends!(htlc_success_txn[1], commitment_txn[0]);
4785         assert_eq!(htlc_success_txn[0].input.len(), 1);
4786         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4787         assert_eq!(htlc_success_txn[1].input.len(), 1);
4788         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4789         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_success_txn[1].input[0].previous_output);
4790         assert_eq!(htlc_success_txn[2], commitment_txn[0]);
4791         assert_eq!(htlc_success_txn[3], htlc_success_txn[0]);
4792         assert_eq!(htlc_success_txn[4], htlc_success_txn[1]);
4793         assert_ne!(htlc_success_txn[0].input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
4794
4795         mine_transaction(&nodes[1], &htlc_timeout_tx);
4796         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4797         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
4798         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4799         assert!(htlc_updates.update_add_htlcs.is_empty());
4800         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4801         let first_htlc_id = htlc_updates.update_fail_htlcs[0].htlc_id;
4802         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4803         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4804         check_added_monitors!(nodes[1], 1);
4805
4806         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4807         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4808         {
4809                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4810         }
4811         expect_payment_failed_with_update!(nodes[0], duplicate_payment_hash, false, chan_2.0.contents.short_channel_id, true);
4812
4813         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4814         // Note that the fee paid is effectively double as the HTLC value (including the nodes[1] fee
4815         // and nodes[2] fee) is rounded down and then claimed in full.
4816         mine_transaction(&nodes[1], &htlc_success_txn[0]);
4817         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(196*2), true, true);
4818         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4819         assert!(updates.update_add_htlcs.is_empty());
4820         assert!(updates.update_fail_htlcs.is_empty());
4821         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4822         assert_ne!(updates.update_fulfill_htlcs[0].htlc_id, first_htlc_id);
4823         assert!(updates.update_fail_malformed_htlcs.is_empty());
4824         check_added_monitors!(nodes[1], 1);
4825
4826         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4827         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4828
4829         let events = nodes[0].node.get_and_clear_pending_events();
4830         match events[0] {
4831                 Event::PaymentSent { ref payment_preimage, ref payment_hash, .. } => {
4832                         assert_eq!(*payment_preimage, our_payment_preimage);
4833                         assert_eq!(*payment_hash, duplicate_payment_hash);
4834                 }
4835                 _ => panic!("Unexpected event"),
4836         }
4837 }
4838
4839 #[test]
4840 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4841         let chanmon_cfgs = create_chanmon_cfgs(2);
4842         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4843         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4844         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4845
4846         // Create some initial channels
4847         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4848
4849         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
4850         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4851         assert_eq!(local_txn.len(), 1);
4852         assert_eq!(local_txn[0].input.len(), 1);
4853         check_spends!(local_txn[0], chan_1.3);
4854
4855         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4856         nodes[1].node.claim_funds(payment_preimage);
4857         expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
4858         check_added_monitors!(nodes[1], 1);
4859
4860         mine_transaction(&nodes[1], &local_txn[0]);
4861         check_added_monitors!(nodes[1], 1);
4862         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4863         let events = nodes[1].node.get_and_clear_pending_msg_events();
4864         match events[0] {
4865                 MessageSendEvent::UpdateHTLCs { .. } => {},
4866                 _ => panic!("Unexpected event"),
4867         }
4868         match events[1] {
4869                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4870                 _ => panic!("Unexepected event"),
4871         }
4872         let node_tx = {
4873                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4874                 assert_eq!(node_txn.len(), 3);
4875                 assert_eq!(node_txn[0], node_txn[2]);
4876                 assert_eq!(node_txn[1], local_txn[0]);
4877                 assert_eq!(node_txn[0].input.len(), 1);
4878                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4879                 check_spends!(node_txn[0], local_txn[0]);
4880                 node_txn[0].clone()
4881         };
4882
4883         mine_transaction(&nodes[1], &node_tx);
4884         connect_blocks(&nodes[1], BREAKDOWN_TIMEOUT as u32 - 1);
4885
4886         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4887         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
4888         assert_eq!(spend_txn.len(), 1);
4889         assert_eq!(spend_txn[0].input.len(), 1);
4890         check_spends!(spend_txn[0], node_tx);
4891         assert_eq!(spend_txn[0].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
4892 }
4893
4894 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4895         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4896         // unrevoked commitment transaction.
4897         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4898         // a remote RAA before they could be failed backwards (and combinations thereof).
4899         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4900         // use the same payment hashes.
4901         // Thus, we use a six-node network:
4902         //
4903         // A \         / E
4904         //    - C - D -
4905         // B /         \ F
4906         // And test where C fails back to A/B when D announces its latest commitment transaction
4907         let chanmon_cfgs = create_chanmon_cfgs(6);
4908         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
4909         // When this test was written, the default base fee floated based on the HTLC count.
4910         // It is now fixed, so we simply set the fee to the expected value here.
4911         let mut config = test_default_channel_config();
4912         config.channel_config.forwarding_fee_base_msat = 196;
4913         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs,
4914                 &[Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone()), Some(config.clone())]);
4915         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4916
4917         let _chan_0_2 = create_announced_chan_between_nodes(&nodes, 0, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4918         let _chan_1_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4919         let chan_2_3 = create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4920         let chan_3_4 = create_announced_chan_between_nodes(&nodes, 3, 4, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4921         let chan_3_5  = create_announced_chan_between_nodes(&nodes, 3, 5, channelmanager::provided_init_features(), channelmanager::provided_init_features());
4922
4923         // Rebalance and check output sanity...
4924         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
4925         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
4926         assert_eq!(get_local_commitment_txn!(nodes[3], chan_2_3.2)[0].output.len(), 2);
4927
4928         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan_2_3.2).unwrap().holder_dust_limit_satoshis;
4929         // 0th HTLC:
4930         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
4931         // 1st HTLC:
4932         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
4933         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], ds_dust_limit*1000);
4934         // 2nd HTLC:
4935         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).unwrap()); // not added < dust limit + HTLC tx fee
4936         // 3rd HTLC:
4937         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).unwrap()); // not added < dust limit + HTLC tx fee
4938         // 4th HTLC:
4939         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4940         // 5th HTLC:
4941         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4942         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], 1000000);
4943         // 6th HTLC:
4944         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).unwrap());
4945         // 7th HTLC:
4946         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).unwrap());
4947
4948         // 8th HTLC:
4949         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4950         // 9th HTLC:
4951         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], ds_dust_limit*1000);
4952         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).unwrap()); // not added < dust limit + HTLC tx fee
4953
4954         // 10th HTLC:
4955         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
4956         // 11th HTLC:
4957         let (route, _, _, _) = get_route_and_payment_hash!(nodes[1], nodes[5], 1000000);
4958         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).unwrap());
4959
4960         // Double-check that six of the new HTLC were added
4961         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4962         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4963         assert_eq!(get_local_commitment_txn!(nodes[3], chan_2_3.2).len(), 1);
4964         assert_eq!(get_local_commitment_txn!(nodes[3], chan_2_3.2)[0].output.len(), 8);
4965
4966         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4967         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4968         nodes[4].node.fail_htlc_backwards(&payment_hash_1);
4969         nodes[4].node.fail_htlc_backwards(&payment_hash_3);
4970         nodes[4].node.fail_htlc_backwards(&payment_hash_5);
4971         nodes[4].node.fail_htlc_backwards(&payment_hash_6);
4972         check_added_monitors!(nodes[4], 0);
4973
4974         let failed_destinations = vec![
4975                 HTLCDestination::FailedPayment { payment_hash: payment_hash_1 },
4976                 HTLCDestination::FailedPayment { payment_hash: payment_hash_3 },
4977                 HTLCDestination::FailedPayment { payment_hash: payment_hash_5 },
4978                 HTLCDestination::FailedPayment { payment_hash: payment_hash_6 },
4979         ];
4980         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[4], failed_destinations);
4981         check_added_monitors!(nodes[4], 1);
4982
4983         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4984         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4985         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4986         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4987         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4988         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4989
4990         // Fail 3rd below-dust and 7th above-dust HTLCs
4991         nodes[5].node.fail_htlc_backwards(&payment_hash_2);
4992         nodes[5].node.fail_htlc_backwards(&payment_hash_4);
4993         check_added_monitors!(nodes[5], 0);
4994
4995         let failed_destinations_2 = vec![
4996                 HTLCDestination::FailedPayment { payment_hash: payment_hash_2 },
4997                 HTLCDestination::FailedPayment { payment_hash: payment_hash_4 },
4998         ];
4999         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[5], failed_destinations_2);
5000         check_added_monitors!(nodes[5], 1);
5001
5002         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5003         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5004         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5005         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5006
5007         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan_2_3.2);
5008
5009         // After 4 and 2 removes respectively above in nodes[4] and nodes[5], nodes[3] should receive 6 PaymentForwardedFailed events
5010         let failed_destinations_3 = vec![
5011                 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5012                 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5013                 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5014                 HTLCDestination::NextHopChannel { node_id: Some(nodes[4].node.get_our_node_id()), channel_id: chan_3_4.2 },
5015                 HTLCDestination::NextHopChannel { node_id: Some(nodes[5].node.get_our_node_id()), channel_id: chan_3_5.2 },
5016                 HTLCDestination::NextHopChannel { node_id: Some(nodes[5].node.get_our_node_id()), channel_id: chan_3_5.2 },
5017         ];
5018         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations_3);
5019         check_added_monitors!(nodes[3], 1);
5020         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5021         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5022         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5023         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5024         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5025         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5026         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5027         if deliver_last_raa {
5028                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5029         } else {
5030                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5031         }
5032
5033         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5034         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5035         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5036         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5037         //
5038         // We now broadcast the latest commitment transaction, which *should* result in failures for
5039         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5040         // the non-broadcast above-dust HTLCs.
5041         //
5042         // Alternatively, we may broadcast the previous commitment transaction, which should only
5043         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5044         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan_2_3.2);
5045
5046         if announce_latest {
5047                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5048         } else {
5049                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5050         }
5051         let events = nodes[2].node.get_and_clear_pending_events();
5052         let close_event = if deliver_last_raa {
5053                 assert_eq!(events.len(), 2 + 6);
5054                 events.last().clone().unwrap()
5055         } else {
5056                 assert_eq!(events.len(), 1);
5057                 events.last().clone().unwrap()
5058         };
5059         match close_event {
5060                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
5061                 _ => panic!("Unexpected event"),
5062         }
5063
5064         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5065         check_closed_broadcast!(nodes[2], true);
5066         if deliver_last_raa {
5067                 expect_pending_htlcs_forwardable_from_events!(nodes[2], events[0..1], true);
5068
5069                 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }).take(3).collect();
5070                 expect_htlc_handling_failed_destinations!(nodes[2].node.get_and_clear_pending_events(), expected_destinations);
5071         } else {
5072                 let expected_destinations: Vec<HTLCDestination> = if announce_latest {
5073                         repeat(HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }).take(9).collect()
5074                 } else {
5075                         repeat(HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }).take(6).collect()
5076                 };
5077
5078                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], expected_destinations);
5079         }
5080         check_added_monitors!(nodes[2], 3);
5081
5082         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5083         assert_eq!(cs_msgs.len(), 2);
5084         let mut a_done = false;
5085         for msg in cs_msgs {
5086                 match msg {
5087                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5088                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5089                                 // should be failed-backwards here.
5090                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5091                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5092                                         for htlc in &updates.update_fail_htlcs {
5093                                                 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 });
5094                                         }
5095                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5096                                         assert!(!a_done);
5097                                         a_done = true;
5098                                         &nodes[0]
5099                                 } else {
5100                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5101                                         for htlc in &updates.update_fail_htlcs {
5102                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5103                                         }
5104                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5105                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5106                                         &nodes[1]
5107                                 };
5108                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5109                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5110                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5111                                 if announce_latest {
5112                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5113                                         if *node_id == nodes[0].node.get_our_node_id() {
5114                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5115                                         }
5116                                 }
5117                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5118                         },
5119                         _ => panic!("Unexpected event"),
5120                 }
5121         }
5122
5123         let as_events = nodes[0].node.get_and_clear_pending_events();
5124         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5125         let mut as_failds = HashSet::new();
5126         let mut as_updates = 0;
5127         for event in as_events.iter() {
5128                 if let &Event::PaymentPathFailed { ref payment_hash, ref payment_failed_permanently, ref network_update, .. } = event {
5129                         assert!(as_failds.insert(*payment_hash));
5130                         if *payment_hash != payment_hash_2 {
5131                                 assert_eq!(*payment_failed_permanently, deliver_last_raa);
5132                         } else {
5133                                 assert!(!payment_failed_permanently);
5134                         }
5135                         if network_update.is_some() {
5136                                 as_updates += 1;
5137                         }
5138                 } else { panic!("Unexpected event"); }
5139         }
5140         assert!(as_failds.contains(&payment_hash_1));
5141         assert!(as_failds.contains(&payment_hash_2));
5142         if announce_latest {
5143                 assert!(as_failds.contains(&payment_hash_3));
5144                 assert!(as_failds.contains(&payment_hash_5));
5145         }
5146         assert!(as_failds.contains(&payment_hash_6));
5147
5148         let bs_events = nodes[1].node.get_and_clear_pending_events();
5149         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5150         let mut bs_failds = HashSet::new();
5151         let mut bs_updates = 0;
5152         for event in bs_events.iter() {
5153                 if let &Event::PaymentPathFailed { ref payment_hash, ref payment_failed_permanently, ref network_update, .. } = event {
5154                         assert!(bs_failds.insert(*payment_hash));
5155                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5156                                 assert_eq!(*payment_failed_permanently, deliver_last_raa);
5157                         } else {
5158                                 assert!(!payment_failed_permanently);
5159                         }
5160                         if network_update.is_some() {
5161                                 bs_updates += 1;
5162                         }
5163                 } else { panic!("Unexpected event"); }
5164         }
5165         assert!(bs_failds.contains(&payment_hash_1));
5166         assert!(bs_failds.contains(&payment_hash_2));
5167         if announce_latest {
5168                 assert!(bs_failds.contains(&payment_hash_4));
5169         }
5170         assert!(bs_failds.contains(&payment_hash_5));
5171
5172         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5173         // get a NetworkUpdate. A should have gotten 4 HTLCs which were failed-back due to
5174         // unknown-preimage-etc, B should have gotten 2. Thus, in the
5175         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2 NetworkUpdates.
5176         assert_eq!(as_updates, if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5177         assert_eq!(bs_updates, if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5178 }
5179
5180 #[test]
5181 fn test_fail_backwards_latest_remote_announce_a() {
5182         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5183 }
5184
5185 #[test]
5186 fn test_fail_backwards_latest_remote_announce_b() {
5187         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5188 }
5189
5190 #[test]
5191 fn test_fail_backwards_previous_remote_announce() {
5192         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5193         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5194         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5195 }
5196
5197 #[test]
5198 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5199         let chanmon_cfgs = create_chanmon_cfgs(2);
5200         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5201         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5202         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5203
5204         // Create some initial channels
5205         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5206
5207         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5208         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5209         assert_eq!(local_txn[0].input.len(), 1);
5210         check_spends!(local_txn[0], chan_1.3);
5211
5212         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5213         mine_transaction(&nodes[0], &local_txn[0]);
5214         check_closed_broadcast!(nodes[0], true);
5215         check_added_monitors!(nodes[0], 1);
5216         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5217         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5218
5219         let htlc_timeout = {
5220                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5221                 assert_eq!(node_txn.len(), 2);
5222                 check_spends!(node_txn[0], chan_1.3);
5223                 assert_eq!(node_txn[1].input.len(), 1);
5224                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5225                 check_spends!(node_txn[1], local_txn[0]);
5226                 node_txn[1].clone()
5227         };
5228
5229         mine_transaction(&nodes[0], &htlc_timeout);
5230         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5231         expect_payment_failed!(nodes[0], our_payment_hash, false);
5232
5233         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5234         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5235         assert_eq!(spend_txn.len(), 3);
5236         check_spends!(spend_txn[0], local_txn[0]);
5237         assert_eq!(spend_txn[1].input.len(), 1);
5238         check_spends!(spend_txn[1], htlc_timeout);
5239         assert_eq!(spend_txn[1].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
5240         assert_eq!(spend_txn[2].input.len(), 2);
5241         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5242         assert!(spend_txn[2].input[0].sequence.0 == BREAKDOWN_TIMEOUT as u32 ||
5243                 spend_txn[2].input[1].sequence.0 == BREAKDOWN_TIMEOUT as u32);
5244 }
5245
5246 #[test]
5247 fn test_key_derivation_params() {
5248         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5249         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5250         // let us re-derive the channel key set to then derive a delayed_payment_key.
5251
5252         let chanmon_cfgs = create_chanmon_cfgs(3);
5253
5254         // We manually create the node configuration to backup the seed.
5255         let seed = [42; 32];
5256         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5257         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);
5258         let network_graph = NetworkGraph::new(chanmon_cfgs[0].chain_source.genesis_hash, &chanmon_cfgs[0].logger);
5259         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, network_graph, node_seed: seed, features: channelmanager::provided_init_features() };
5260         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5261         node_cfgs.remove(0);
5262         node_cfgs.insert(0, node);
5263
5264         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5265         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5266
5267         // Create some initial channels
5268         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5269         // for node 0
5270         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5271         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5272         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5273
5274         // Ensure all nodes are at the same height
5275         let node_max_height = nodes.iter().map(|node| node.blocks.lock().unwrap().len()).max().unwrap() as u32;
5276         connect_blocks(&nodes[0], node_max_height - nodes[0].best_block_info().1);
5277         connect_blocks(&nodes[1], node_max_height - nodes[1].best_block_info().1);
5278         connect_blocks(&nodes[2], node_max_height - nodes[2].best_block_info().1);
5279
5280         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5281         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5282         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5283         assert_eq!(local_txn_1[0].input.len(), 1);
5284         check_spends!(local_txn_1[0], chan_1.3);
5285
5286         // We check funding pubkey are unique
5287         let (from_0_funding_key_0, from_0_funding_key_1) = (PublicKey::from_slice(&local_txn_0[0].input[0].witness.to_vec()[3][2..35]), PublicKey::from_slice(&local_txn_0[0].input[0].witness.to_vec()[3][36..69]));
5288         let (from_1_funding_key_0, from_1_funding_key_1) = (PublicKey::from_slice(&local_txn_1[0].input[0].witness.to_vec()[3][2..35]), PublicKey::from_slice(&local_txn_1[0].input[0].witness.to_vec()[3][36..69]));
5289         if from_0_funding_key_0 == from_1_funding_key_0
5290             || from_0_funding_key_0 == from_1_funding_key_1
5291             || from_0_funding_key_1 == from_1_funding_key_0
5292             || from_0_funding_key_1 == from_1_funding_key_1 {
5293                 panic!("Funding pubkeys aren't unique");
5294         }
5295
5296         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5297         mine_transaction(&nodes[0], &local_txn_1[0]);
5298         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
5299         check_closed_broadcast!(nodes[0], true);
5300         check_added_monitors!(nodes[0], 1);
5301         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5302
5303         let htlc_timeout = {
5304                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5305                 assert_eq!(node_txn[1].input.len(), 1);
5306                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5307                 check_spends!(node_txn[1], local_txn_1[0]);
5308                 node_txn[1].clone()
5309         };
5310
5311         mine_transaction(&nodes[0], &htlc_timeout);
5312         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
5313         expect_payment_failed!(nodes[0], our_payment_hash, false);
5314
5315         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5316         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5317         let spend_txn = check_spendable_outputs!(nodes[0], new_keys_manager);
5318         assert_eq!(spend_txn.len(), 3);
5319         check_spends!(spend_txn[0], local_txn_1[0]);
5320         assert_eq!(spend_txn[1].input.len(), 1);
5321         check_spends!(spend_txn[1], htlc_timeout);
5322         assert_eq!(spend_txn[1].input[0].sequence.0, BREAKDOWN_TIMEOUT as u32);
5323         assert_eq!(spend_txn[2].input.len(), 2);
5324         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5325         assert!(spend_txn[2].input[0].sequence.0 == BREAKDOWN_TIMEOUT as u32 ||
5326                 spend_txn[2].input[1].sequence.0 == BREAKDOWN_TIMEOUT as u32);
5327 }
5328
5329 #[test]
5330 fn test_static_output_closing_tx() {
5331         let chanmon_cfgs = create_chanmon_cfgs(2);
5332         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5333         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5334         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5335
5336         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5337
5338         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5339         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5340
5341         mine_transaction(&nodes[0], &closing_tx);
5342         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
5343         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5344
5345         let spend_txn = check_spendable_outputs!(nodes[0], node_cfgs[0].keys_manager);
5346         assert_eq!(spend_txn.len(), 1);
5347         check_spends!(spend_txn[0], closing_tx);
5348
5349         mine_transaction(&nodes[1], &closing_tx);
5350         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
5351         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5352
5353         let spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
5354         assert_eq!(spend_txn.len(), 1);
5355         check_spends!(spend_txn[0], closing_tx);
5356 }
5357
5358 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5359         let chanmon_cfgs = create_chanmon_cfgs(2);
5360         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5361         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5362         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5363         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5364
5365         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3_000_000 });
5366
5367         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5368         // present in B's local commitment transaction, but none of A's commitment transactions.
5369         nodes[1].node.claim_funds(payment_preimage);
5370         check_added_monitors!(nodes[1], 1);
5371         expect_payment_claimed!(nodes[1], payment_hash, if use_dust { 50000 } else { 3_000_000 });
5372
5373         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5374         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5375         expect_payment_sent_without_paths!(nodes[0], payment_preimage);
5376
5377         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5378         check_added_monitors!(nodes[0], 1);
5379         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5380         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5381         check_added_monitors!(nodes[1], 1);
5382
5383         let starting_block = nodes[1].best_block_info();
5384         let mut block = Block {
5385                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
5386                 txdata: vec![],
5387         };
5388         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5389                 connect_block(&nodes[1], &block);
5390                 block.header.prev_blockhash = block.block_hash();
5391         }
5392         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5393         check_closed_broadcast!(nodes[1], true);
5394         check_added_monitors!(nodes[1], 1);
5395         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
5396 }
5397
5398 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5399         let chanmon_cfgs = create_chanmon_cfgs(2);
5400         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5401         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5402         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5403         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5404
5405         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], if use_dust { 50000 } else { 3000000 });
5406         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
5407         check_added_monitors!(nodes[0], 1);
5408
5409         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5410
5411         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5412         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5413         // to "time out" the HTLC.
5414
5415         let starting_block = nodes[1].best_block_info();
5416         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
5417
5418         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5419                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5420                 header.prev_blockhash = header.block_hash();
5421         }
5422         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5423         check_closed_broadcast!(nodes[0], true);
5424         check_added_monitors!(nodes[0], 1);
5425         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5426 }
5427
5428 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5429         let chanmon_cfgs = create_chanmon_cfgs(3);
5430         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5431         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5432         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5433         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5434
5435         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5436         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5437         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5438         // actually revoked.
5439         let htlc_value = if use_dust { 50000 } else { 3000000 };
5440         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5441         nodes[1].node.fail_htlc_backwards(&our_payment_hash);
5442         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
5443         check_added_monitors!(nodes[1], 1);
5444
5445         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5446         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5447         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5448         check_added_monitors!(nodes[0], 1);
5449         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5450         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5451         check_added_monitors!(nodes[1], 1);
5452         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5453         check_added_monitors!(nodes[1], 1);
5454         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5455
5456         if check_revoke_no_close {
5457                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5458                 check_added_monitors!(nodes[0], 1);
5459         }
5460
5461         let starting_block = nodes[1].best_block_info();
5462         let mut block = Block {
5463                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
5464                 txdata: vec![],
5465         };
5466         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5467                 connect_block(&nodes[0], &block);
5468                 block.header.prev_blockhash = block.block_hash();
5469         }
5470         if !check_revoke_no_close {
5471                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5472                 check_closed_broadcast!(nodes[0], true);
5473                 check_added_monitors!(nodes[0], 1);
5474                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
5475         } else {
5476                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5477         }
5478 }
5479
5480 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5481 // There are only a few cases to test here:
5482 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5483 //    broadcastable commitment transactions result in channel closure,
5484 //  * its included in an unrevoked-but-previous remote commitment transaction,
5485 //  * its included in the latest remote or local commitment transactions.
5486 // We test each of the three possible commitment transactions individually and use both dust and
5487 // non-dust HTLCs.
5488 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5489 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5490 // tested for at least one of the cases in other tests.
5491 #[test]
5492 fn htlc_claim_single_commitment_only_a() {
5493         do_htlc_claim_local_commitment_only(true);
5494         do_htlc_claim_local_commitment_only(false);
5495
5496         do_htlc_claim_current_remote_commitment_only(true);
5497         do_htlc_claim_current_remote_commitment_only(false);
5498 }
5499
5500 #[test]
5501 fn htlc_claim_single_commitment_only_b() {
5502         do_htlc_claim_previous_remote_commitment_only(true, false);
5503         do_htlc_claim_previous_remote_commitment_only(false, false);
5504         do_htlc_claim_previous_remote_commitment_only(true, true);
5505         do_htlc_claim_previous_remote_commitment_only(false, true);
5506 }
5507
5508 #[test]
5509 #[should_panic]
5510 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5511         let chanmon_cfgs = create_chanmon_cfgs(2);
5512         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5513         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5514         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5515         // Force duplicate randomness for every get-random call
5516         for node in nodes.iter() {
5517                 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([0; 32]);
5518         }
5519
5520         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5521         let channel_value_satoshis=10000;
5522         let push_msat=10001;
5523         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5524         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5525         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &node0_to_1_send_open_channel);
5526         get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
5527
5528         // Create a second channel with the same random values. This used to panic due to a colliding
5529         // channel_id, but now panics due to a colliding outbound SCID alias.
5530         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5531 }
5532
5533 #[test]
5534 fn bolt2_open_channel_sending_node_checks_part2() {
5535         let chanmon_cfgs = create_chanmon_cfgs(2);
5536         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5537         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5538         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5539
5540         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5541         let channel_value_satoshis=2^24;
5542         let push_msat=10001;
5543         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5544
5545         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5546         let channel_value_satoshis=10000;
5547         // Test when push_msat is equal to 1000 * funding_satoshis.
5548         let push_msat=1000*channel_value_satoshis+1;
5549         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5550
5551         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5552         let channel_value_satoshis=10000;
5553         let push_msat=10001;
5554         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
5555         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5556         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5557
5558         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5559         // 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
5560         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5561
5562         // 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.
5563         assert!(BREAKDOWN_TIMEOUT>0);
5564         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5565
5566         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5567         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5568         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5569
5570         // 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.
5571         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5572         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5573         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5574         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5575         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5576 }
5577
5578 #[test]
5579 fn bolt2_open_channel_sane_dust_limit() {
5580         let chanmon_cfgs = create_chanmon_cfgs(2);
5581         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5582         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5583         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5584
5585         let channel_value_satoshis=1000000;
5586         let push_msat=10001;
5587         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5588         let mut node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5589         node0_to_1_send_open_channel.dust_limit_satoshis = 547;
5590         node0_to_1_send_open_channel.channel_reserve_satoshis = 100001;
5591
5592         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &node0_to_1_send_open_channel);
5593         let events = nodes[1].node.get_and_clear_pending_msg_events();
5594         let err_msg = match events[0] {
5595                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
5596                         msg.clone()
5597                 },
5598                 _ => panic!("Unexpected event"),
5599         };
5600         assert_eq!(err_msg.data, "dust_limit_satoshis (547) is greater than the implementation limit (546)");
5601 }
5602
5603 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5604 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5605 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5606 // is no longer affordable once it's freed.
5607 #[test]
5608 fn test_fail_holding_cell_htlc_upon_free() {
5609         let chanmon_cfgs = create_chanmon_cfgs(2);
5610         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5611         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5612         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5613         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5614
5615         // First nodes[0] generates an update_fee, setting the channel's
5616         // pending_update_fee.
5617         {
5618                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5619                 *feerate_lock += 20;
5620         }
5621         nodes[0].node.timer_tick_occurred();
5622         check_added_monitors!(nodes[0], 1);
5623
5624         let events = nodes[0].node.get_and_clear_pending_msg_events();
5625         assert_eq!(events.len(), 1);
5626         let (update_msg, commitment_signed) = match events[0] {
5627                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5628                         (update_fee.as_ref(), commitment_signed)
5629                 },
5630                 _ => panic!("Unexpected event"),
5631         };
5632
5633         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5634
5635         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5636         let channel_reserve = chan_stat.channel_reserve_msat;
5637         let feerate = get_feerate!(nodes[0], chan.2);
5638         let opt_anchors = get_opt_anchors!(nodes[0], chan.2);
5639
5640         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5641         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1, opt_anchors);
5642         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send);
5643
5644         // Send a payment which passes reserve checks but gets stuck in the holding cell.
5645         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
5646         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5647         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5648
5649         // Flush the pending fee update.
5650         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5651         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5652         check_added_monitors!(nodes[1], 1);
5653         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
5654         check_added_monitors!(nodes[0], 1);
5655
5656         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
5657         // HTLC, but now that the fee has been raised the payment will now fail, causing
5658         // us to surface its failure to the user.
5659         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5660         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5661         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);
5662         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 {}",
5663                 hex::encode(our_payment_hash.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
5664         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5665
5666         // Check that the payment failed to be sent out.
5667         let events = nodes[0].node.get_and_clear_pending_events();
5668         assert_eq!(events.len(), 1);
5669         match &events[0] {
5670                 &Event::PaymentPathFailed { ref payment_id, ref payment_hash, ref payment_failed_permanently, ref network_update, ref all_paths_failed, ref short_channel_id, .. } => {
5671                         assert_eq!(PaymentId(our_payment_hash.0), *payment_id.as_ref().unwrap());
5672                         assert_eq!(our_payment_hash.clone(), *payment_hash);
5673                         assert_eq!(*payment_failed_permanently, false);
5674                         assert_eq!(*all_paths_failed, true);
5675                         assert_eq!(*network_update, None);
5676                         assert_eq!(*short_channel_id, Some(route.paths[0][0].short_channel_id));
5677                 },
5678                 _ => panic!("Unexpected event"),
5679         }
5680 }
5681
5682 // Test that if multiple HTLCs are released from the holding cell and one is
5683 // valid but the other is no longer valid upon release, the valid HTLC can be
5684 // successfully completed while the other one fails as expected.
5685 #[test]
5686 fn test_free_and_fail_holding_cell_htlcs() {
5687         let chanmon_cfgs = create_chanmon_cfgs(2);
5688         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5689         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5690         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5691         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5692
5693         // First nodes[0] generates an update_fee, setting the channel's
5694         // pending_update_fee.
5695         {
5696                 let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
5697                 *feerate_lock += 200;
5698         }
5699         nodes[0].node.timer_tick_occurred();
5700         check_added_monitors!(nodes[0], 1);
5701
5702         let events = nodes[0].node.get_and_clear_pending_msg_events();
5703         assert_eq!(events.len(), 1);
5704         let (update_msg, commitment_signed) = match events[0] {
5705                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5706                         (update_fee.as_ref(), commitment_signed)
5707                 },
5708                 _ => panic!("Unexpected event"),
5709         };
5710
5711         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5712
5713         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5714         let channel_reserve = chan_stat.channel_reserve_msat;
5715         let feerate = get_feerate!(nodes[0], chan.2);
5716         let opt_anchors = get_opt_anchors!(nodes[0], chan.2);
5717
5718         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5719         let amt_1 = 20000;
5720         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1, opt_anchors) - amt_1;
5721         let (route_1, payment_hash_1, payment_preimage_1, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], amt_1);
5722         let (route_2, payment_hash_2, _, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], amt_2);
5723
5724         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
5725         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
5726         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5727         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
5728         let payment_id_2 = PaymentId(nodes[0].keys_manager.get_secure_random_bytes());
5729         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2), payment_id_2).unwrap();
5730         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5731         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
5732
5733         // Flush the pending fee update.
5734         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5735         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5736         check_added_monitors!(nodes[1], 1);
5737         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
5738         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
5739         check_added_monitors!(nodes[0], 2);
5740
5741         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
5742         // but now that the fee has been raised the second payment will now fail, causing us
5743         // to surface its failure to the user. The first payment should succeed.
5744         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5745         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5746         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);
5747         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 {}",
5748                 hex::encode(payment_hash_2.0), chan_stat.channel_reserve_msat, hex::encode(chan.2));
5749         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5750
5751         // Check that the second payment failed to be sent out.
5752         let events = nodes[0].node.get_and_clear_pending_events();
5753         assert_eq!(events.len(), 1);
5754         match &events[0] {
5755                 &Event::PaymentPathFailed { ref payment_id, ref payment_hash, ref payment_failed_permanently, ref network_update, ref all_paths_failed, ref short_channel_id, .. } => {
5756                         assert_eq!(payment_id_2, *payment_id.as_ref().unwrap());
5757                         assert_eq!(payment_hash_2.clone(), *payment_hash);
5758                         assert_eq!(*payment_failed_permanently, false);
5759                         assert_eq!(*all_paths_failed, true);
5760                         assert_eq!(*network_update, None);
5761                         assert_eq!(*short_channel_id, Some(route_2.paths[0][0].short_channel_id));
5762                 },
5763                 _ => panic!("Unexpected event"),
5764         }
5765
5766         // Complete the first payment and the RAA from the fee update.
5767         let (payment_event, send_raa_event) = {
5768                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
5769                 assert_eq!(msgs.len(), 2);
5770                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
5771         };
5772         let raa = match send_raa_event {
5773                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
5774                 _ => panic!("Unexpected event"),
5775         };
5776         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
5777         check_added_monitors!(nodes[1], 1);
5778         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5779         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5780         let events = nodes[1].node.get_and_clear_pending_events();
5781         assert_eq!(events.len(), 1);
5782         match events[0] {
5783                 Event::PendingHTLCsForwardable { .. } => {},
5784                 _ => panic!("Unexpected event"),
5785         }
5786         nodes[1].node.process_pending_htlc_forwards();
5787         let events = nodes[1].node.get_and_clear_pending_events();
5788         assert_eq!(events.len(), 1);
5789         match events[0] {
5790                 Event::PaymentReceived { .. } => {},
5791                 _ => panic!("Unexpected event"),
5792         }
5793         nodes[1].node.claim_funds(payment_preimage_1);
5794         check_added_monitors!(nodes[1], 1);
5795         expect_payment_claimed!(nodes[1], payment_hash_1, amt_1);
5796
5797         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5798         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
5799         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
5800         expect_payment_sent!(nodes[0], payment_preimage_1);
5801 }
5802
5803 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
5804 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
5805 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
5806 // once it's freed.
5807 #[test]
5808 fn test_fail_holding_cell_htlc_upon_free_multihop() {
5809         let chanmon_cfgs = create_chanmon_cfgs(3);
5810         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5811         // When this test was written, the default base fee floated based on the HTLC count.
5812         // It is now fixed, so we simply set the fee to the expected value here.
5813         let mut config = test_default_channel_config();
5814         config.channel_config.forwarding_fee_base_msat = 196;
5815         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config.clone()), Some(config.clone()), Some(config.clone())]);
5816         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5817         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5818         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5819
5820         // First nodes[1] generates an update_fee, setting the channel's
5821         // pending_update_fee.
5822         {
5823                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
5824                 *feerate_lock += 20;
5825         }
5826         nodes[1].node.timer_tick_occurred();
5827         check_added_monitors!(nodes[1], 1);
5828
5829         let events = nodes[1].node.get_and_clear_pending_msg_events();
5830         assert_eq!(events.len(), 1);
5831         let (update_msg, commitment_signed) = match events[0] {
5832                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5833                         (update_fee.as_ref(), commitment_signed)
5834                 },
5835                 _ => panic!("Unexpected event"),
5836         };
5837
5838         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
5839
5840         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
5841         let channel_reserve = chan_stat.channel_reserve_msat;
5842         let feerate = get_feerate!(nodes[0], chan_0_1.2);
5843         let opt_anchors = get_opt_anchors!(nodes[0], chan_0_1.2);
5844
5845         // Send a payment which passes reserve checks but gets stuck in the holding cell.
5846         let feemsat = 239;
5847         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
5848         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1, opt_anchors) - total_routing_fee_msat;
5849         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], max_can_send);
5850         let payment_event = {
5851                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
5852                 check_added_monitors!(nodes[0], 1);
5853
5854                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5855                 assert_eq!(events.len(), 1);
5856
5857                 SendEvent::from_event(events.remove(0))
5858         };
5859         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5860         check_added_monitors!(nodes[1], 0);
5861         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5862         expect_pending_htlcs_forwardable!(nodes[1]);
5863
5864         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
5865         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5866
5867         // Flush the pending fee update.
5868         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
5869         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5870         check_added_monitors!(nodes[2], 1);
5871         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
5872         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
5873         check_added_monitors!(nodes[1], 2);
5874
5875         // A final RAA message is generated to finalize the fee update.
5876         let events = nodes[1].node.get_and_clear_pending_msg_events();
5877         assert_eq!(events.len(), 1);
5878
5879         let raa_msg = match &events[0] {
5880                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
5881                         msg.clone()
5882                 },
5883                 _ => panic!("Unexpected event"),
5884         };
5885
5886         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
5887         check_added_monitors!(nodes[2], 1);
5888         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
5889
5890         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
5891         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
5892         assert_eq!(process_htlc_forwards_event.len(), 2);
5893         match &process_htlc_forwards_event[0] {
5894                 &Event::PendingHTLCsForwardable { .. } => {},
5895                 _ => panic!("Unexpected event"),
5896         }
5897
5898         // In response, we call ChannelManager's process_pending_htlc_forwards
5899         nodes[1].node.process_pending_htlc_forwards();
5900         check_added_monitors!(nodes[1], 1);
5901
5902         // This causes the HTLC to be failed backwards.
5903         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
5904         assert_eq!(fail_event.len(), 1);
5905         let (fail_msg, commitment_signed) = match &fail_event[0] {
5906                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
5907                         assert_eq!(updates.update_add_htlcs.len(), 0);
5908                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
5909                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
5910                         assert_eq!(updates.update_fail_htlcs.len(), 1);
5911                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
5912                 },
5913                 _ => panic!("Unexpected event"),
5914         };
5915
5916         // Pass the failure messages back to nodes[0].
5917         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5918         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
5919
5920         // Complete the HTLC failure+removal process.
5921         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5922         check_added_monitors!(nodes[0], 1);
5923         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
5924         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
5925         check_added_monitors!(nodes[1], 2);
5926         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
5927         assert_eq!(final_raa_event.len(), 1);
5928         let raa = match &final_raa_event[0] {
5929                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
5930                 _ => panic!("Unexpected event"),
5931         };
5932         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
5933         expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_1_2.0.contents.short_channel_id, false);
5934         check_added_monitors!(nodes[0], 1);
5935 }
5936
5937 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5938 // 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.
5939 //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.
5940
5941 #[test]
5942 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5943         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5944         let chanmon_cfgs = create_chanmon_cfgs(2);
5945         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5946         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5947         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5948         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5949
5950         let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
5951         route.paths[0][0].fee_msat = 100;
5952
5953         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
5954                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
5955         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5956         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5957 }
5958
5959 #[test]
5960 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
5961         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5962         let chanmon_cfgs = create_chanmon_cfgs(2);
5963         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5964         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5965         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5966         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5967
5968         let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
5969         route.paths[0][0].fee_msat = 0;
5970         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
5971                 assert_eq!(err, "Cannot send 0-msat HTLC"));
5972
5973         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5974         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
5975 }
5976
5977 #[test]
5978 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
5979         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5980         let chanmon_cfgs = create_chanmon_cfgs(2);
5981         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5982         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5983         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5984         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
5985
5986         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
5987         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
5988         check_added_monitors!(nodes[0], 1);
5989         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5990         updates.update_add_htlcs[0].amount_msat = 0;
5991
5992         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5993         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
5994         check_closed_broadcast!(nodes[1], true).unwrap();
5995         check_added_monitors!(nodes[1], 1);
5996         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Remote side tried to send a 0-msat HTLC".to_string() });
5997 }
5998
5999 #[test]
6000 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6001         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6002         //It is enforced when constructing a route.
6003         let chanmon_cfgs = create_chanmon_cfgs(2);
6004         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6005         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6006         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6007         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6008
6009         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id())
6010                 .with_features(channelmanager::provided_invoice_features());
6011         let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_params, 100000000, 0);
6012         route.paths[0].last_mut().unwrap().cltv_expiry_delta = 500000001;
6013         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::RouteError { ref err },
6014                 assert_eq!(err, &"Channel CLTV overflowed?"));
6015 }
6016
6017 #[test]
6018 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6019         //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.
6020         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6021         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6022         let chanmon_cfgs = create_chanmon_cfgs(2);
6023         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6024         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6025         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6026         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6027         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6028
6029         for i in 0..max_accepted_htlcs {
6030                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6031                 let payment_event = {
6032                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6033                         check_added_monitors!(nodes[0], 1);
6034
6035                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6036                         assert_eq!(events.len(), 1);
6037                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6038                                 assert_eq!(htlcs[0].htlc_id, i);
6039                         } else {
6040                                 assert!(false);
6041                         }
6042                         SendEvent::from_event(events.remove(0))
6043                 };
6044                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6045                 check_added_monitors!(nodes[1], 0);
6046                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6047
6048                 expect_pending_htlcs_forwardable!(nodes[1]);
6049                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6050         }
6051         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100000);
6052         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
6053                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6054
6055         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6056         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6057 }
6058
6059 #[test]
6060 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6061         //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.
6062         let chanmon_cfgs = create_chanmon_cfgs(2);
6063         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6064         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6065         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6066         let channel_value = 100000;
6067         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6068         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6069
6070         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6071
6072         let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_in_flight);
6073         // Manually create a route over our max in flight (which our router normally automatically
6074         // limits us to.
6075         route.paths[0][0].fee_msat =  max_in_flight + 1;
6076         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
6077                 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)));
6078
6079         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6080         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);
6081
6082         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6083 }
6084
6085 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6086 #[test]
6087 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6088         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6089         let chanmon_cfgs = create_chanmon_cfgs(2);
6090         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6091         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6092         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6093         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6094         let htlc_minimum_msat: u64;
6095         {
6096                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6097                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6098                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6099         }
6100
6101         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], htlc_minimum_msat);
6102         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6103         check_added_monitors!(nodes[0], 1);
6104         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6105         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6106         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6107         assert!(nodes[1].node.list_channels().is_empty());
6108         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6109         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()));
6110         check_added_monitors!(nodes[1], 1);
6111         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6112 }
6113
6114 #[test]
6115 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6116         //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
6117         let chanmon_cfgs = create_chanmon_cfgs(2);
6118         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6119         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6120         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6121         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6122
6123         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6124         let channel_reserve = chan_stat.channel_reserve_msat;
6125         let feerate = get_feerate!(nodes[0], chan.2);
6126         let opt_anchors = get_opt_anchors!(nodes[0], chan.2);
6127         // The 2* and +1 are for the fee spike reserve.
6128         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1, opt_anchors);
6129
6130         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6131         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], max_can_send);
6132         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6133         check_added_monitors!(nodes[0], 1);
6134         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6135
6136         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6137         // at this time channel-initiatee receivers are not required to enforce that senders
6138         // respect the fee_spike_reserve.
6139         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6140         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6141
6142         assert!(nodes[1].node.list_channels().is_empty());
6143         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6144         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6145         check_added_monitors!(nodes[1], 1);
6146         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6147 }
6148
6149 #[test]
6150 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6151         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6152         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6153         let chanmon_cfgs = create_chanmon_cfgs(2);
6154         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6155         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6156         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6157         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6158
6159         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3999999);
6160         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6161         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6162         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6163         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height, &None).unwrap();
6164         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6165
6166         let mut msg = msgs::UpdateAddHTLC {
6167                 channel_id: chan.2,
6168                 htlc_id: 0,
6169                 amount_msat: 1000,
6170                 payment_hash: our_payment_hash,
6171                 cltv_expiry: htlc_cltv,
6172                 onion_routing_packet: onion_packet.clone(),
6173         };
6174
6175         for i in 0..super::channel::OUR_MAX_HTLCS {
6176                 msg.htlc_id = i as u64;
6177                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6178         }
6179         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6180         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6181
6182         assert!(nodes[1].node.list_channels().is_empty());
6183         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6184         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6185         check_added_monitors!(nodes[1], 1);
6186         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6187 }
6188
6189 #[test]
6190 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6191         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6192         let chanmon_cfgs = create_chanmon_cfgs(2);
6193         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6194         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6195         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6196         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6197
6198         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6199         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6200         check_added_monitors!(nodes[0], 1);
6201         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6202         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6203         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6204
6205         assert!(nodes[1].node.list_channels().is_empty());
6206         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6207         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6208         check_added_monitors!(nodes[1], 1);
6209         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6210 }
6211
6212 #[test]
6213 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6214         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6215         let chanmon_cfgs = create_chanmon_cfgs(2);
6216         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6217         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6218         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6219
6220         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6221         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6222         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6223         check_added_monitors!(nodes[0], 1);
6224         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6225         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6226         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6227
6228         assert!(nodes[1].node.list_channels().is_empty());
6229         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6230         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6231         check_added_monitors!(nodes[1], 1);
6232         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6233 }
6234
6235 #[test]
6236 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6237         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6238         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6239         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6240         let chanmon_cfgs = create_chanmon_cfgs(2);
6241         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6242         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6243         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6244
6245         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6246         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6247         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6248         check_added_monitors!(nodes[0], 1);
6249         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6250         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6251
6252         //Disconnect and Reconnect
6253         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6254         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6255         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
6256         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6257         assert_eq!(reestablish_1.len(), 1);
6258         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
6259         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6260         assert_eq!(reestablish_2.len(), 1);
6261         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6262         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6263         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6264         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6265
6266         //Resend HTLC
6267         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6268         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6269         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6270         check_added_monitors!(nodes[1], 1);
6271         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6272
6273         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6274
6275         assert!(nodes[1].node.list_channels().is_empty());
6276         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6277         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6278         check_added_monitors!(nodes[1], 1);
6279         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: err_msg.data });
6280 }
6281
6282 #[test]
6283 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6284         //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.
6285
6286         let chanmon_cfgs = create_chanmon_cfgs(2);
6287         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6288         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6289         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6290         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6291         let (route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6292         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6293
6294         check_added_monitors!(nodes[0], 1);
6295         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6296         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6297
6298         let update_msg = msgs::UpdateFulfillHTLC{
6299                 channel_id: chan.2,
6300                 htlc_id: 0,
6301                 payment_preimage: our_payment_preimage,
6302         };
6303
6304         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6305
6306         assert!(nodes[0].node.list_channels().is_empty());
6307         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6308         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()));
6309         check_added_monitors!(nodes[0], 1);
6310         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6311 }
6312
6313 #[test]
6314 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6315         //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.
6316
6317         let chanmon_cfgs = create_chanmon_cfgs(2);
6318         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6319         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6320         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6321         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6322
6323         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6324         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6325         check_added_monitors!(nodes[0], 1);
6326         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6327         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6328
6329         let update_msg = msgs::UpdateFailHTLC{
6330                 channel_id: chan.2,
6331                 htlc_id: 0,
6332                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6333         };
6334
6335         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6336
6337         assert!(nodes[0].node.list_channels().is_empty());
6338         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6339         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()));
6340         check_added_monitors!(nodes[0], 1);
6341         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6342 }
6343
6344 #[test]
6345 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6346         //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.
6347
6348         let chanmon_cfgs = create_chanmon_cfgs(2);
6349         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6350         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6351         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6352         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6353
6354         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6355         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6356         check_added_monitors!(nodes[0], 1);
6357         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6358         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6359         let update_msg = msgs::UpdateFailMalformedHTLC{
6360                 channel_id: chan.2,
6361                 htlc_id: 0,
6362                 sha256_of_onion: [1; 32],
6363                 failure_code: 0x8000,
6364         };
6365
6366         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6367
6368         assert!(nodes[0].node.list_channels().is_empty());
6369         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6370         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()));
6371         check_added_monitors!(nodes[0], 1);
6372         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6373 }
6374
6375 #[test]
6376 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6377         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6378
6379         let chanmon_cfgs = create_chanmon_cfgs(2);
6380         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6381         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6382         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6383         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6384
6385         let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
6386
6387         nodes[1].node.claim_funds(our_payment_preimage);
6388         check_added_monitors!(nodes[1], 1);
6389         expect_payment_claimed!(nodes[1], our_payment_hash, 100_000);
6390
6391         let events = nodes[1].node.get_and_clear_pending_msg_events();
6392         assert_eq!(events.len(), 1);
6393         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6394                 match events[0] {
6395                         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, .. } } => {
6396                                 assert!(update_add_htlcs.is_empty());
6397                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6398                                 assert!(update_fail_htlcs.is_empty());
6399                                 assert!(update_fail_malformed_htlcs.is_empty());
6400                                 assert!(update_fee.is_none());
6401                                 update_fulfill_htlcs[0].clone()
6402                         },
6403                         _ => panic!("Unexpected event"),
6404                 }
6405         };
6406
6407         update_fulfill_msg.htlc_id = 1;
6408
6409         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6410
6411         assert!(nodes[0].node.list_channels().is_empty());
6412         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6413         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6414         check_added_monitors!(nodes[0], 1);
6415         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6416 }
6417
6418 #[test]
6419 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6420         //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.
6421
6422         let chanmon_cfgs = create_chanmon_cfgs(2);
6423         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6424         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6425         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6426         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6427
6428         let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
6429
6430         nodes[1].node.claim_funds(our_payment_preimage);
6431         check_added_monitors!(nodes[1], 1);
6432         expect_payment_claimed!(nodes[1], our_payment_hash, 100_000);
6433
6434         let events = nodes[1].node.get_and_clear_pending_msg_events();
6435         assert_eq!(events.len(), 1);
6436         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6437                 match events[0] {
6438                         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, .. } } => {
6439                                 assert!(update_add_htlcs.is_empty());
6440                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6441                                 assert!(update_fail_htlcs.is_empty());
6442                                 assert!(update_fail_malformed_htlcs.is_empty());
6443                                 assert!(update_fee.is_none());
6444                                 update_fulfill_htlcs[0].clone()
6445                         },
6446                         _ => panic!("Unexpected event"),
6447                 }
6448         };
6449
6450         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6451
6452         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6453
6454         assert!(nodes[0].node.list_channels().is_empty());
6455         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6456         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6457         check_added_monitors!(nodes[0], 1);
6458         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6459 }
6460
6461 #[test]
6462 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6463         //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.
6464
6465         let chanmon_cfgs = create_chanmon_cfgs(2);
6466         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6467         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6468         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6469         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6470
6471         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
6472         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6473         check_added_monitors!(nodes[0], 1);
6474
6475         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6476         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6477
6478         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6479         check_added_monitors!(nodes[1], 0);
6480         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6481
6482         let events = nodes[1].node.get_and_clear_pending_msg_events();
6483
6484         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6485                 match events[0] {
6486                         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, .. } } => {
6487                                 assert!(update_add_htlcs.is_empty());
6488                                 assert!(update_fulfill_htlcs.is_empty());
6489                                 assert!(update_fail_htlcs.is_empty());
6490                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6491                                 assert!(update_fee.is_none());
6492                                 update_fail_malformed_htlcs[0].clone()
6493                         },
6494                         _ => panic!("Unexpected event"),
6495                 }
6496         };
6497         update_msg.failure_code &= !0x8000;
6498         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6499
6500         assert!(nodes[0].node.list_channels().is_empty());
6501         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6502         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6503         check_added_monitors!(nodes[0], 1);
6504         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: err_msg.data });
6505 }
6506
6507 #[test]
6508 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6509         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6510         //    * 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.
6511
6512         let chanmon_cfgs = create_chanmon_cfgs(3);
6513         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6514         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6515         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6516         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6517         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6518
6519         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100000);
6520
6521         //First hop
6522         let mut payment_event = {
6523                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6524                 check_added_monitors!(nodes[0], 1);
6525                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6526                 assert_eq!(events.len(), 1);
6527                 SendEvent::from_event(events.remove(0))
6528         };
6529         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6530         check_added_monitors!(nodes[1], 0);
6531         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6532         expect_pending_htlcs_forwardable!(nodes[1]);
6533         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6534         assert_eq!(events_2.len(), 1);
6535         check_added_monitors!(nodes[1], 1);
6536         payment_event = SendEvent::from_event(events_2.remove(0));
6537         assert_eq!(payment_event.msgs.len(), 1);
6538
6539         //Second Hop
6540         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6541         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6542         check_added_monitors!(nodes[2], 0);
6543         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6544
6545         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6546         assert_eq!(events_3.len(), 1);
6547         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6548                 match events_3[0] {
6549                         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 } } => {
6550                                 assert!(update_add_htlcs.is_empty());
6551                                 assert!(update_fulfill_htlcs.is_empty());
6552                                 assert!(update_fail_htlcs.is_empty());
6553                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6554                                 assert!(update_fee.is_none());
6555                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6556                         },
6557                         _ => panic!("Unexpected event"),
6558                 }
6559         };
6560
6561         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6562
6563         check_added_monitors!(nodes[1], 0);
6564         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6565         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
6566         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6567         assert_eq!(events_4.len(), 1);
6568
6569         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6570         match events_4[0] {
6571                 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, .. } } => {
6572                         assert!(update_add_htlcs.is_empty());
6573                         assert!(update_fulfill_htlcs.is_empty());
6574                         assert_eq!(update_fail_htlcs.len(), 1);
6575                         assert!(update_fail_malformed_htlcs.is_empty());
6576                         assert!(update_fee.is_none());
6577                 },
6578                 _ => panic!("Unexpected event"),
6579         };
6580
6581         check_added_monitors!(nodes[1], 1);
6582 }
6583
6584 #[test]
6585 fn test_channel_failed_after_message_with_badonion_node_perm_bits_set() {
6586         let chanmon_cfgs = create_chanmon_cfgs(3);
6587         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6588         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6589         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6590         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6591         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6592
6593         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100_000);
6594
6595         // First hop
6596         let mut payment_event = {
6597                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6598                 check_added_monitors!(nodes[0], 1);
6599                 SendEvent::from_node(&nodes[0])
6600         };
6601
6602         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6603         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6604         expect_pending_htlcs_forwardable!(nodes[1]);
6605         check_added_monitors!(nodes[1], 1);
6606         payment_event = SendEvent::from_node(&nodes[1]);
6607         assert_eq!(payment_event.msgs.len(), 1);
6608
6609         // Second Hop
6610         payment_event.msgs[0].onion_routing_packet.version = 1; // Trigger an invalid_onion_version error
6611         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6612         check_added_monitors!(nodes[2], 0);
6613         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6614
6615         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6616         assert_eq!(events_3.len(), 1);
6617         match events_3[0] {
6618                 MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6619                         let mut update_msg = updates.update_fail_malformed_htlcs[0].clone();
6620                         // Set the NODE bit (BADONION and PERM already set in invalid_onion_version error)
6621                         update_msg.failure_code |= 0x2000;
6622
6623                         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg);
6624                         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true);
6625                 },
6626                 _ => panic!("Unexpected event"),
6627         }
6628
6629         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1],
6630                 vec![HTLCDestination::NextHopChannel {
6631                         node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
6632         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6633         assert_eq!(events_4.len(), 1);
6634         check_added_monitors!(nodes[1], 1);
6635
6636         match events_4[0] {
6637                 MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6638                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
6639                         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false, true);
6640                 },
6641                 _ => panic!("Unexpected event"),
6642         }
6643
6644         let events_5 = nodes[0].node.get_and_clear_pending_events();
6645         assert_eq!(events_5.len(), 1);
6646
6647         // Expect a PaymentPathFailed event with a ChannelFailure network update for the channel between
6648         // the node originating the error to its next hop.
6649         match events_5[0] {
6650                 Event::PaymentPathFailed { network_update:
6651                         Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }), error_code, ..
6652                 } => {
6653                         assert_eq!(short_channel_id, chan_2.0.contents.short_channel_id);
6654                         assert!(is_permanent);
6655                         assert_eq!(error_code, Some(0x8000|0x4000|0x2000|4));
6656                 },
6657                 _ => panic!("Unexpected event"),
6658         }
6659
6660         // TODO: Test actual removal of channel from NetworkGraph when it's implemented.
6661 }
6662
6663 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6664         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6665         // 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
6666         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6667
6668         let mut chanmon_cfgs = create_chanmon_cfgs(2);
6669         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6670         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6671         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6672         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6673         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6674
6675         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6676
6677         // We route 2 dust-HTLCs between A and B
6678         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6679         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6680         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6681
6682         // Cache one local commitment tx as previous
6683         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6684
6685         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6686         nodes[1].node.fail_htlc_backwards(&payment_hash_2);
6687         check_added_monitors!(nodes[1], 0);
6688         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_2 }]);
6689         check_added_monitors!(nodes[1], 1);
6690
6691         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6692         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6693         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6694         check_added_monitors!(nodes[0], 1);
6695
6696         // Cache one local commitment tx as lastest
6697         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6698
6699         let events = nodes[0].node.get_and_clear_pending_msg_events();
6700         match events[0] {
6701                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6702                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6703                 },
6704                 _ => panic!("Unexpected event"),
6705         }
6706         match events[1] {
6707                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6708                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6709                 },
6710                 _ => panic!("Unexpected event"),
6711         }
6712
6713         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6714         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6715         if announce_latest {
6716                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
6717         } else {
6718                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
6719         }
6720
6721         check_closed_broadcast!(nodes[0], true);
6722         check_added_monitors!(nodes[0], 1);
6723         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6724
6725         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6726         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6727         let events = nodes[0].node.get_and_clear_pending_events();
6728         // Only 2 PaymentPathFailed events should show up, over-dust HTLC has to be failed by timeout tx
6729         assert_eq!(events.len(), 2);
6730         let mut first_failed = false;
6731         for event in events {
6732                 match event {
6733                         Event::PaymentPathFailed { payment_hash, .. } => {
6734                                 if payment_hash == payment_hash_1 {
6735                                         assert!(!first_failed);
6736                                         first_failed = true;
6737                                 } else {
6738                                         assert_eq!(payment_hash, payment_hash_2);
6739                                 }
6740                         }
6741                         _ => panic!("Unexpected event"),
6742                 }
6743         }
6744 }
6745
6746 #[test]
6747 fn test_failure_delay_dust_htlc_local_commitment() {
6748         do_test_failure_delay_dust_htlc_local_commitment(true);
6749         do_test_failure_delay_dust_htlc_local_commitment(false);
6750 }
6751
6752 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6753         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6754         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6755         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6756         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6757         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6758         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6759
6760         let chanmon_cfgs = create_chanmon_cfgs(3);
6761         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6762         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6763         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6764         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6765
6766         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6767
6768         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6769         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6770
6771         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6772         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
6773
6774         // We revoked bs_commitment_tx
6775         if revoked {
6776                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6777                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
6778         }
6779
6780         let mut timeout_tx = Vec::new();
6781         if local {
6782                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6783                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
6784                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6785                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6786                 expect_payment_failed!(nodes[0], dust_hash, false);
6787
6788                 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS - ANTI_REORG_DELAY);
6789                 check_closed_broadcast!(nodes[0], true);
6790                 check_added_monitors!(nodes[0], 1);
6791                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6792                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[1].clone());
6793                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6794                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6795                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6796                 mine_transaction(&nodes[0], &timeout_tx[0]);
6797                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6798                 expect_payment_failed!(nodes[0], non_dust_hash, false);
6799         } else {
6800                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6801                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
6802                 check_closed_broadcast!(nodes[0], true);
6803                 check_added_monitors!(nodes[0], 1);
6804                 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
6805                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6806
6807                 connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
6808                 timeout_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().drain(..)
6809                         .filter(|tx| tx.input[0].previous_output.txid == bs_commitment_tx[0].txid()).collect();
6810                 check_spends!(timeout_tx[0], bs_commitment_tx[0]);
6811                 // For both a revoked or non-revoked commitment transaction, after ANTI_REORG_DELAY the
6812                 // dust HTLC should have been failed.
6813                 expect_payment_failed!(nodes[0], dust_hash, false);
6814
6815                 if !revoked {
6816                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6817                 } else {
6818                         assert_eq!(timeout_tx[0].lock_time.0, 0);
6819                 }
6820                 // We fail non-dust-HTLC 2 by broadcast of local timeout/revocation-claim tx
6821                 mine_transaction(&nodes[0], &timeout_tx[0]);
6822                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6823                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6824                 expect_payment_failed!(nodes[0], non_dust_hash, false);
6825         }
6826 }
6827
6828 #[test]
6829 fn test_sweep_outbound_htlc_failure_update() {
6830         do_test_sweep_outbound_htlc_failure_update(false, true);
6831         do_test_sweep_outbound_htlc_failure_update(false, false);
6832         do_test_sweep_outbound_htlc_failure_update(true, false);
6833 }
6834
6835 #[test]
6836 fn test_user_configurable_csv_delay() {
6837         // We test our channel constructors yield errors when we pass them absurd csv delay
6838
6839         let mut low_our_to_self_config = UserConfig::default();
6840         low_our_to_self_config.channel_handshake_config.our_to_self_delay = 6;
6841         let mut high_their_to_self_config = UserConfig::default();
6842         high_their_to_self_config.channel_handshake_limits.their_to_self_delay = 100;
6843         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6844         let chanmon_cfgs = create_chanmon_cfgs(2);
6845         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6846         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6847         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6848
6849         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6850         if let Err(error) = Channel::new_outbound(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
6851                 &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), 1000000, 1000000, 0,
6852                 &low_our_to_self_config, 0, 42)
6853         {
6854                 match error {
6855                         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())); },
6856                         _ => panic!("Unexpected event"),
6857                 }
6858         } else { assert!(false) }
6859
6860         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6861         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6862         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6863         open_channel.to_self_delay = 200;
6864         if let Err(error) = Channel::new_from_req(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
6865                 &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &open_channel, 0,
6866                 &low_our_to_self_config, 0, &nodes[0].logger, 42)
6867         {
6868                 match error {
6869                         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()));  },
6870                         _ => panic!("Unexpected event"),
6871                 }
6872         } else { assert!(false); }
6873
6874         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6875         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6876         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
6877         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6878         accept_channel.to_self_delay = 200;
6879         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
6880         let reason_msg;
6881         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6882                 match action {
6883                         &ErrorAction::SendErrorMessage { ref msg } => {
6884                                 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()));
6885                                 reason_msg = msg.data.clone();
6886                         },
6887                         _ => { panic!(); }
6888                 }
6889         } else { panic!(); }
6890         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: reason_msg });
6891
6892         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6893         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6894         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6895         open_channel.to_self_delay = 200;
6896         if let Err(error) = Channel::new_from_req(&LowerBoundedFeeEstimator::new(&test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) }),
6897                 &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), &channelmanager::provided_init_features(), &open_channel, 0,
6898                 &high_their_to_self_config, 0, &nodes[0].logger, 42)
6899         {
6900                 match error {
6901                         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())); },
6902                         _ => panic!("Unexpected event"),
6903                 }
6904         } else { assert!(false); }
6905 }
6906
6907 #[test]
6908 fn test_check_htlc_underpaying() {
6909         // Send payment through A -> B but A is maliciously
6910         // sending a probe payment (i.e less than expected value0
6911         // to B, B should refuse payment.
6912
6913         let chanmon_cfgs = create_chanmon_cfgs(2);
6914         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6915         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6916         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6917
6918         // Create some initial channels
6919         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6920
6921         let scorer = test_utils::TestScorer::with_penalty(0);
6922         let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
6923         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id()).with_features(channelmanager::provided_invoice_features());
6924         let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None, 10_000, TEST_FINAL_CLTV, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
6925         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
6926         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200).unwrap();
6927         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
6928         check_added_monitors!(nodes[0], 1);
6929
6930         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6931         assert_eq!(events.len(), 1);
6932         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
6933         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6934         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6935
6936         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
6937         // and then will wait a second random delay before failing the HTLC back:
6938         expect_pending_htlcs_forwardable!(nodes[1]);
6939         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
6940
6941         // Node 3 is expecting payment of 100_000 but received 10_000,
6942         // it should fail htlc like we didn't know the preimage.
6943         nodes[1].node.process_pending_htlc_forwards();
6944
6945         let events = nodes[1].node.get_and_clear_pending_msg_events();
6946         assert_eq!(events.len(), 1);
6947         let (update_fail_htlc, commitment_signed) = match events[0] {
6948                 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 } } => {
6949                         assert!(update_add_htlcs.is_empty());
6950                         assert!(update_fulfill_htlcs.is_empty());
6951                         assert_eq!(update_fail_htlcs.len(), 1);
6952                         assert!(update_fail_malformed_htlcs.is_empty());
6953                         assert!(update_fee.is_none());
6954                         (update_fail_htlcs[0].clone(), commitment_signed)
6955                 },
6956                 _ => panic!("Unexpected event"),
6957         };
6958         check_added_monitors!(nodes[1], 1);
6959
6960         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6961         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6962
6963         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
6964         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
6965         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
6966         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
6967 }
6968
6969 #[test]
6970 fn test_announce_disable_channels() {
6971         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
6972         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6973
6974         let chanmon_cfgs = create_chanmon_cfgs(2);
6975         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6976         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6977         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6978
6979         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6980         create_announced_chan_between_nodes(&nodes, 1, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6981         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
6982
6983         // Disconnect peers
6984         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6985         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6986
6987         nodes[0].node.timer_tick_occurred(); // Enabled -> DisabledStaged
6988         nodes[0].node.timer_tick_occurred(); // DisabledStaged -> Disabled
6989         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6990         assert_eq!(msg_events.len(), 3);
6991         let mut chans_disabled = HashMap::new();
6992         for e in msg_events {
6993                 match e {
6994                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6995                                 assert_eq!(msg.contents.flags & (1<<1), 1<<1); // The "channel disabled" bit should be set
6996                                 // Check that each channel gets updated exactly once
6997                                 if chans_disabled.insert(msg.contents.short_channel_id, msg.contents.timestamp).is_some() {
6998                                         panic!("Generated ChannelUpdate for wrong chan!");
6999                                 }
7000                         },
7001                         _ => panic!("Unexpected event"),
7002                 }
7003         }
7004         // Reconnect peers
7005         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7006         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7007         assert_eq!(reestablish_1.len(), 3);
7008         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
7009         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7010         assert_eq!(reestablish_2.len(), 3);
7011
7012         // Reestablish chan_1
7013         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7014         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7015         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7016         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7017         // Reestablish chan_2
7018         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7019         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7020         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7021         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7022         // Reestablish chan_3
7023         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7024         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7025         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7026         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7027
7028         nodes[0].node.timer_tick_occurred();
7029         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7030         nodes[0].node.timer_tick_occurred();
7031         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7032         assert_eq!(msg_events.len(), 3);
7033         for e in msg_events {
7034                 match e {
7035                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7036                                 assert_eq!(msg.contents.flags & (1<<1), 0); // The "channel disabled" bit should be off
7037                                 match chans_disabled.remove(&msg.contents.short_channel_id) {
7038                                         // Each update should have a higher timestamp than the previous one, replacing
7039                                         // the old one.
7040                                         Some(prev_timestamp) => assert!(msg.contents.timestamp > prev_timestamp),
7041                                         None => panic!("Generated ChannelUpdate for wrong chan!"),
7042                                 }
7043                         },
7044                         _ => panic!("Unexpected event"),
7045                 }
7046         }
7047         // Check that each channel gets updated exactly once
7048         assert!(chans_disabled.is_empty());
7049 }
7050
7051 #[test]
7052 fn test_bump_penalty_txn_on_revoked_commitment() {
7053         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7054         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7055
7056         let chanmon_cfgs = create_chanmon_cfgs(2);
7057         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7058         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7059         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7060
7061         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7062
7063         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7064         let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id())
7065                 .with_features(channelmanager::provided_invoice_features());
7066         let (route,_, _, _) = get_route_and_payment_hash!(nodes[1], nodes[0], payment_params, 3000000, 30);
7067         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7068
7069         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7070         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7071         assert_eq!(revoked_txn[0].output.len(), 4);
7072         assert_eq!(revoked_txn[0].input.len(), 1);
7073         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7074         let revoked_txid = revoked_txn[0].txid();
7075
7076         let mut penalty_sum = 0;
7077         for outp in revoked_txn[0].output.iter() {
7078                 if outp.script_pubkey.is_v0_p2wsh() {
7079                         penalty_sum += outp.value;
7080                 }
7081         }
7082
7083         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7084         let header_114 = connect_blocks(&nodes[1], 14);
7085
7086         // Actually revoke tx by claiming a HTLC
7087         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7088         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7089         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7090         check_added_monitors!(nodes[1], 1);
7091
7092         // One or more justice tx should have been broadcast, check it
7093         let penalty_1;
7094         let feerate_1;
7095         {
7096                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7097                 assert_eq!(node_txn.len(), 2); // justice tx (broadcasted from ChannelMonitor) + local commitment tx
7098                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7099                 assert_eq!(node_txn[0].output.len(), 1);
7100                 check_spends!(node_txn[0], revoked_txn[0]);
7101                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7102                 feerate_1 = fee_1 * 1000 / node_txn[0].weight() as u64;
7103                 penalty_1 = node_txn[0].txid();
7104                 node_txn.clear();
7105         };
7106
7107         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7108         connect_blocks(&nodes[1], 15);
7109         let mut penalty_2 = penalty_1;
7110         let mut feerate_2 = 0;
7111         {
7112                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7113                 assert_eq!(node_txn.len(), 1);
7114                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7115                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7116                         assert_eq!(node_txn[0].output.len(), 1);
7117                         check_spends!(node_txn[0], revoked_txn[0]);
7118                         penalty_2 = node_txn[0].txid();
7119                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7120                         assert_ne!(penalty_2, penalty_1);
7121                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7122                         feerate_2 = fee_2 * 1000 / node_txn[0].weight() as u64;
7123                         // Verify 25% bump heuristic
7124                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7125                         node_txn.clear();
7126                 }
7127         }
7128         assert_ne!(feerate_2, 0);
7129
7130         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7131         connect_blocks(&nodes[1], 1);
7132         let penalty_3;
7133         let mut feerate_3 = 0;
7134         {
7135                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7136                 assert_eq!(node_txn.len(), 1);
7137                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7138                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7139                         assert_eq!(node_txn[0].output.len(), 1);
7140                         check_spends!(node_txn[0], revoked_txn[0]);
7141                         penalty_3 = node_txn[0].txid();
7142                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7143                         assert_ne!(penalty_3, penalty_2);
7144                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7145                         feerate_3 = fee_3 * 1000 / node_txn[0].weight() as u64;
7146                         // Verify 25% bump heuristic
7147                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7148                         node_txn.clear();
7149                 }
7150         }
7151         assert_ne!(feerate_3, 0);
7152
7153         nodes[1].node.get_and_clear_pending_events();
7154         nodes[1].node.get_and_clear_pending_msg_events();
7155 }
7156
7157 #[test]
7158 fn test_bump_penalty_txn_on_revoked_htlcs() {
7159         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7160         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7161
7162         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7163         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7164         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7165         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7166         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7167
7168         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7169         // Lock HTLC in both directions (using a slightly lower CLTV delay to provide timely RBF bumps)
7170         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id()).with_features(channelmanager::provided_invoice_features());
7171         let scorer = test_utils::TestScorer::with_penalty(0);
7172         let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7173         let route = get_route(&nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(), None,
7174                 3_000_000, 50, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
7175         let payment_preimage = send_along_route(&nodes[0], route, &[&nodes[1]], 3_000_000).0;
7176         let payment_params = PaymentParameters::from_node_id(nodes[0].node.get_our_node_id()).with_features(channelmanager::provided_invoice_features());
7177         let route = get_route(&nodes[1].node.get_our_node_id(), &payment_params, &nodes[1].network_graph.read_only(), None,
7178                 3_000_000, 50, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
7179         send_along_route(&nodes[1], route, &[&nodes[0]], 3_000_000);
7180
7181         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7182         assert_eq!(revoked_local_txn[0].input.len(), 1);
7183         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7184
7185         // Revoke local commitment tx
7186         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7187
7188         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7189         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7190         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7191         check_closed_broadcast!(nodes[1], true);
7192         check_added_monitors!(nodes[1], 1);
7193         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
7194         connect_blocks(&nodes[1], 49); // Confirm blocks until the HTLC expires (note CLTV was explicitly 50 above)
7195
7196         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
7197         assert_eq!(revoked_htlc_txn.len(), 3);
7198         check_spends!(revoked_htlc_txn[1], chan.3);
7199
7200         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7201         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7202         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7203
7204         assert_eq!(revoked_htlc_txn[2].input.len(), 1);
7205         assert_eq!(revoked_htlc_txn[2].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7206         assert_eq!(revoked_htlc_txn[2].output.len(), 1);
7207         check_spends!(revoked_htlc_txn[2], revoked_local_txn[0]);
7208
7209         // Broadcast set of revoked txn on A
7210         let hash_128 = connect_blocks(&nodes[0], 40);
7211         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7212         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7213         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7214         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[2].clone()] });
7215         let events = nodes[0].node.get_and_clear_pending_events();
7216         expect_pending_htlcs_forwardable_from_events!(nodes[0], events[0..1], true);
7217         match events.last().unwrap() {
7218                 Event::ChannelClosed { reason: ClosureReason::CommitmentTxConfirmed, .. } => {}
7219                 _ => panic!("Unexpected event"),
7220         }
7221         let first;
7222         let feerate_1;
7223         let penalty_txn;
7224         {
7225                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7226                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7227                 // Verify claim tx are spending revoked HTLC txn
7228
7229                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7230                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7231                 // which are included in the same block (they are broadcasted because we scan the
7232                 // transactions linearly and generate claims as we go, they likely should be removed in the
7233                 // future).
7234                 assert_eq!(node_txn[0].input.len(), 1);
7235                 check_spends!(node_txn[0], revoked_local_txn[0]);
7236                 assert_eq!(node_txn[1].input.len(), 1);
7237                 check_spends!(node_txn[1], revoked_local_txn[0]);
7238                 assert_eq!(node_txn[2].input.len(), 1);
7239                 check_spends!(node_txn[2], revoked_local_txn[0]);
7240
7241                 // Each of the three justice transactions claim a separate (single) output of the three
7242                 // available, which we check here:
7243                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7244                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7245                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7246
7247                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7248                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[2].input[0].previous_output);
7249
7250                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7251                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7252                 // a remote commitment tx has already been confirmed).
7253                 check_spends!(node_txn[3], chan.3);
7254
7255                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7256                 // output, checked above).
7257                 assert_eq!(node_txn[4].input.len(), 2);
7258                 assert_eq!(node_txn[4].output.len(), 1);
7259                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7260
7261                 first = node_txn[4].txid();
7262                 // Store both feerates for later comparison
7263                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[4].output[0].value;
7264                 feerate_1 = fee_1 * 1000 / node_txn[4].weight() as u64;
7265                 penalty_txn = vec![node_txn[2].clone()];
7266                 node_txn.clear();
7267         }
7268
7269         // Connect one more block to see if bumped penalty are issued for HTLC txn
7270         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7271         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7272         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7273         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7274
7275         // Few more blocks to confirm penalty txn
7276         connect_blocks(&nodes[0], 4);
7277         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7278         let header_144 = connect_blocks(&nodes[0], 9);
7279         let node_txn = {
7280                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7281                 assert_eq!(node_txn.len(), 1);
7282
7283                 assert_eq!(node_txn[0].input.len(), 2);
7284                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[2]);
7285                 // Verify bumped tx is different and 25% bump heuristic
7286                 assert_ne!(first, node_txn[0].txid());
7287                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[2].output[0].value - node_txn[0].output[0].value;
7288                 let feerate_2 = fee_2 * 1000 / node_txn[0].weight() as u64;
7289                 assert!(feerate_2 * 100 > feerate_1 * 125);
7290                 let txn = vec![node_txn[0].clone()];
7291                 node_txn.clear();
7292                 txn
7293         };
7294         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7295         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7296         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
7297         connect_blocks(&nodes[0], 20);
7298         {
7299                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7300                 // We verify than no new transaction has been broadcast because previously
7301                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7302                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7303                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7304                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7305                 // up bumped justice generation.
7306                 assert_eq!(node_txn.len(), 0);
7307                 node_txn.clear();
7308         }
7309         check_closed_broadcast!(nodes[0], true);
7310         check_added_monitors!(nodes[0], 1);
7311 }
7312
7313 #[test]
7314 fn test_bump_penalty_txn_on_remote_commitment() {
7315         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7316         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7317
7318         // Create 2 HTLCs
7319         // Provide preimage for one
7320         // Check aggregation
7321
7322         let chanmon_cfgs = create_chanmon_cfgs(2);
7323         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7324         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7325         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7326
7327         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7328         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 3_000_000);
7329         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7330
7331         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7332         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7333         assert_eq!(remote_txn[0].output.len(), 4);
7334         assert_eq!(remote_txn[0].input.len(), 1);
7335         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7336
7337         // Claim a HTLC without revocation (provide B monitor with preimage)
7338         nodes[1].node.claim_funds(payment_preimage);
7339         expect_payment_claimed!(nodes[1], payment_hash, 3_000_000);
7340         mine_transaction(&nodes[1], &remote_txn[0]);
7341         check_added_monitors!(nodes[1], 2);
7342         connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
7343
7344         // One or more claim tx should have been broadcast, check it
7345         let timeout;
7346         let preimage;
7347         let preimage_bump;
7348         let feerate_timeout;
7349         let feerate_preimage;
7350         {
7351                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7352                 // 5 transactions including:
7353                 //   local commitment + HTLC-Success
7354                 //   preimage and timeout sweeps from remote commitment + preimage sweep bump
7355                 assert_eq!(node_txn.len(), 5);
7356                 assert_eq!(node_txn[0].input.len(), 1);
7357                 assert_eq!(node_txn[3].input.len(), 1);
7358                 assert_eq!(node_txn[4].input.len(), 1);
7359                 check_spends!(node_txn[0], remote_txn[0]);
7360                 check_spends!(node_txn[3], remote_txn[0]);
7361                 check_spends!(node_txn[4], remote_txn[0]);
7362
7363                 check_spends!(node_txn[1], chan.3); // local commitment
7364                 check_spends!(node_txn[2], node_txn[1]); // local HTLC-Success
7365
7366                 preimage = node_txn[0].txid();
7367                 let index = node_txn[0].input[0].previous_output.vout;
7368                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7369                 feerate_preimage = fee * 1000 / node_txn[0].weight() as u64;
7370
7371                 let (preimage_bump_tx, timeout_tx) = if node_txn[3].input[0].previous_output == node_txn[0].input[0].previous_output {
7372                         (node_txn[3].clone(), node_txn[4].clone())
7373                 } else {
7374                         (node_txn[4].clone(), node_txn[3].clone())
7375                 };
7376
7377                 preimage_bump = preimage_bump_tx;
7378                 check_spends!(preimage_bump, remote_txn[0]);
7379                 assert_eq!(node_txn[0].input[0].previous_output, preimage_bump.input[0].previous_output);
7380
7381                 timeout = timeout_tx.txid();
7382                 let index = timeout_tx.input[0].previous_output.vout;
7383                 let fee = remote_txn[0].output[index as usize].value - timeout_tx.output[0].value;
7384                 feerate_timeout = fee * 1000 / timeout_tx.weight() as u64;
7385
7386                 node_txn.clear();
7387         };
7388         assert_ne!(feerate_timeout, 0);
7389         assert_ne!(feerate_preimage, 0);
7390
7391         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7392         connect_blocks(&nodes[1], 15);
7393         {
7394                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7395                 assert_eq!(node_txn.len(), 1);
7396                 assert_eq!(node_txn[0].input.len(), 1);
7397                 assert_eq!(preimage_bump.input.len(), 1);
7398                 check_spends!(node_txn[0], remote_txn[0]);
7399                 check_spends!(preimage_bump, remote_txn[0]);
7400
7401                 let index = preimage_bump.input[0].previous_output.vout;
7402                 let fee = remote_txn[0].output[index as usize].value - preimage_bump.output[0].value;
7403                 let new_feerate = fee * 1000 / preimage_bump.weight() as u64;
7404                 assert!(new_feerate * 100 > feerate_timeout * 125);
7405                 assert_ne!(timeout, preimage_bump.txid());
7406
7407                 let index = node_txn[0].input[0].previous_output.vout;
7408                 let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7409                 let new_feerate = fee * 1000 / node_txn[0].weight() as u64;
7410                 assert!(new_feerate * 100 > feerate_preimage * 125);
7411                 assert_ne!(preimage, node_txn[0].txid());
7412
7413                 node_txn.clear();
7414         }
7415
7416         nodes[1].node.get_and_clear_pending_events();
7417         nodes[1].node.get_and_clear_pending_msg_events();
7418 }
7419
7420 #[test]
7421 fn test_counterparty_raa_skip_no_crash() {
7422         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7423         // commitment transaction, we would have happily carried on and provided them the next
7424         // commitment transaction based on one RAA forward. This would probably eventually have led to
7425         // channel closure, but it would not have resulted in funds loss. Still, our
7426         // EnforcingSigner would have panicked as it doesn't like jumps into the future. Here, we
7427         // check simply that the channel is closed in response to such an RAA, but don't check whether
7428         // we decide to punish our counterparty for revoking their funds (as we don't currently
7429         // implement that).
7430         let chanmon_cfgs = create_chanmon_cfgs(2);
7431         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7432         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7433         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7434         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).2;
7435
7436         let per_commitment_secret;
7437         let next_per_commitment_point;
7438         {
7439                 let mut guard = nodes[0].node.channel_state.lock().unwrap();
7440                 let keys = guard.by_id.get_mut(&channel_id).unwrap().get_signer();
7441
7442                 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7443
7444                 // Make signer believe we got a counterparty signature, so that it allows the revocation
7445                 keys.get_enforcement_state().last_holder_commitment -= 1;
7446                 per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
7447
7448                 // Must revoke without gaps
7449                 keys.get_enforcement_state().last_holder_commitment -= 1;
7450                 keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
7451
7452                 keys.get_enforcement_state().last_holder_commitment -= 1;
7453                 next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7454                         &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7455         }
7456
7457         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7458                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7459         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7460         check_added_monitors!(nodes[1], 1);
7461         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: "Received an unexpected revoke_and_ack".to_string() });
7462 }
7463
7464 #[test]
7465 fn test_bump_txn_sanitize_tracking_maps() {
7466         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7467         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7468
7469         let chanmon_cfgs = create_chanmon_cfgs(2);
7470         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7471         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7472         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7473
7474         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7475         // Lock HTLC in both directions
7476         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000);
7477         let (_, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000);
7478
7479         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7480         assert_eq!(revoked_local_txn[0].input.len(), 1);
7481         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7482
7483         // Revoke local commitment tx
7484         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
7485
7486         // Broadcast set of revoked txn on A
7487         connect_blocks(&nodes[0], TEST_FINAL_CLTV + 2 - CHAN_CONFIRM_DEPTH);
7488         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[0], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash_2 }]);
7489         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
7490
7491         mine_transaction(&nodes[0], &revoked_local_txn[0]);
7492         check_closed_broadcast!(nodes[0], true);
7493         check_added_monitors!(nodes[0], 1);
7494         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
7495         let penalty_txn = {
7496                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7497                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7498                 check_spends!(node_txn[0], revoked_local_txn[0]);
7499                 check_spends!(node_txn[1], revoked_local_txn[0]);
7500                 check_spends!(node_txn[2], revoked_local_txn[0]);
7501                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7502                 node_txn.clear();
7503                 penalty_txn
7504         };
7505         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
7506         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7507         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7508         {
7509                 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(OutPoint { txid: chan.3.txid(), index: 0 }).unwrap();
7510                 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
7511                 assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
7512         }
7513 }
7514
7515 #[test]
7516 fn test_pending_claimed_htlc_no_balance_underflow() {
7517         // Tests that if we have a pending outbound HTLC as well as a claimed-but-not-fully-removed
7518         // HTLC we will not underflow when we call `Channel::get_balance_msat()`.
7519         let chanmon_cfgs = create_chanmon_cfgs(2);
7520         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7521         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7522         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7523         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7524
7525         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1_010_000);
7526         nodes[1].node.claim_funds(payment_preimage);
7527         expect_payment_claimed!(nodes[1], payment_hash, 1_010_000);
7528         check_added_monitors!(nodes[1], 1);
7529         let fulfill_ev = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7530
7531         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &fulfill_ev.update_fulfill_htlcs[0]);
7532         expect_payment_sent_without_paths!(nodes[0], payment_preimage);
7533         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &fulfill_ev.commitment_signed);
7534         check_added_monitors!(nodes[0], 1);
7535         let (_raa, _cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7536
7537         // At this point nodes[1] has received 1,010k msat (10k msat more than their reserve) and can
7538         // send an HTLC back (though it will go in the holding cell). Send an HTLC back and check we
7539         // can get our balance.
7540
7541         // Get a route from nodes[1] to nodes[0] by getting a route going the other way and then flip
7542         // the public key of the only hop. This works around ChannelDetails not showing the
7543         // almost-claimed HTLC as available balance.
7544         let (mut route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 10_000);
7545         route.payment_params = None; // This is all wrong, but unnecessary
7546         route.paths[0][0].pubkey = nodes[0].node.get_our_node_id();
7547         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[0]);
7548         nodes[1].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
7549
7550         assert_eq!(nodes[1].node.list_channels()[0].balance_msat, 1_000_000);
7551 }
7552
7553 #[test]
7554 fn test_channel_conf_timeout() {
7555         // Tests that, for inbound channels, we give up on them if the funding transaction does not
7556         // confirm within 2016 blocks, as recommended by BOLT 2.
7557         let chanmon_cfgs = create_chanmon_cfgs(2);
7558         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7559         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7560         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7561
7562         let _funding_tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 1_000_000, 100_000, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7563
7564         // The outbound node should wait forever for confirmation:
7565         // This matches `channel::FUNDING_CONF_DEADLINE_BLOCKS` and BOLT 2's suggested timeout, thus is
7566         // copied here instead of directly referencing the constant.
7567         connect_blocks(&nodes[0], 2016);
7568         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7569
7570         // The inbound node should fail the channel after exactly 2016 blocks
7571         connect_blocks(&nodes[1], 2015);
7572         check_added_monitors!(nodes[1], 0);
7573         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7574
7575         connect_blocks(&nodes[1], 1);
7576         check_added_monitors!(nodes[1], 1);
7577         check_closed_event!(nodes[1], 1, ClosureReason::FundingTimedOut);
7578         let close_ev = nodes[1].node.get_and_clear_pending_msg_events();
7579         assert_eq!(close_ev.len(), 1);
7580         match close_ev[0] {
7581                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, ref node_id } => {
7582                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7583                         assert_eq!(msg.data, "Channel closed because funding transaction failed to confirm within 2016 blocks");
7584                 },
7585                 _ => panic!("Unexpected event"),
7586         }
7587 }
7588
7589 #[test]
7590 fn test_override_channel_config() {
7591         let chanmon_cfgs = create_chanmon_cfgs(2);
7592         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7593         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7594         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7595
7596         // Node0 initiates a channel to node1 using the override config.
7597         let mut override_config = UserConfig::default();
7598         override_config.channel_handshake_config.our_to_self_delay = 200;
7599
7600         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
7601
7602         // Assert the channel created by node0 is using the override config.
7603         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7604         assert_eq!(res.channel_flags, 0);
7605         assert_eq!(res.to_self_delay, 200);
7606 }
7607
7608 #[test]
7609 fn test_override_0msat_htlc_minimum() {
7610         let mut zero_config = UserConfig::default();
7611         zero_config.channel_handshake_config.our_htlc_minimum_msat = 0;
7612         let chanmon_cfgs = create_chanmon_cfgs(2);
7613         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7614         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7615         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7616
7617         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
7618         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7619         assert_eq!(res.htlc_minimum_msat, 1);
7620
7621         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &res);
7622         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7623         assert_eq!(res.htlc_minimum_msat, 1);
7624 }
7625
7626 #[test]
7627 fn test_channel_update_has_correct_htlc_maximum_msat() {
7628         // Tests that the `ChannelUpdate` message has the correct values for `htlc_maximum_msat` set.
7629         // Bolt 7 specifies that if present `htlc_maximum_msat`:
7630         // 1. MUST be set to less than or equal to the channel capacity. In LDK, this is capped to
7631         // 90% of the `channel_value`.
7632         // 2. MUST be set to less than or equal to the `max_htlc_value_in_flight_msat` received from the peer.
7633
7634         let mut config_30_percent = UserConfig::default();
7635         config_30_percent.channel_handshake_config.announced_channel = true;
7636         config_30_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 30;
7637         let mut config_50_percent = UserConfig::default();
7638         config_50_percent.channel_handshake_config.announced_channel = true;
7639         config_50_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 50;
7640         let mut config_95_percent = UserConfig::default();
7641         config_95_percent.channel_handshake_config.announced_channel = true;
7642         config_95_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 95;
7643         let mut config_100_percent = UserConfig::default();
7644         config_100_percent.channel_handshake_config.announced_channel = true;
7645         config_100_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 100;
7646
7647         let chanmon_cfgs = create_chanmon_cfgs(4);
7648         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7649         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[Some(config_30_percent), Some(config_50_percent), Some(config_95_percent), Some(config_100_percent)]);
7650         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7651
7652         let channel_value_satoshis = 100000;
7653         let channel_value_msat = channel_value_satoshis * 1000;
7654         let channel_value_30_percent_msat = (channel_value_msat as f64 * 0.3) as u64;
7655         let channel_value_50_percent_msat = (channel_value_msat as f64 * 0.5) as u64;
7656         let channel_value_90_percent_msat = (channel_value_msat as f64 * 0.9) as u64;
7657
7658         let (node_0_chan_update, node_1_chan_update, _, _)  = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value_satoshis, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7659         let (node_2_chan_update, node_3_chan_update, _, _)  = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, channel_value_satoshis, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
7660
7661         // Assert that `node[0]`'s `ChannelUpdate` is capped at 50 percent of the `channel_value`, as
7662         // that's the value of `node[1]`'s `holder_max_htlc_value_in_flight_msat`.
7663         assert_eq!(node_0_chan_update.contents.htlc_maximum_msat, channel_value_50_percent_msat);
7664         // Assert that `node[1]`'s `ChannelUpdate` is capped at 30 percent of the `channel_value`, as
7665         // that's the value of `node[0]`'s `holder_max_htlc_value_in_flight_msat`.
7666         assert_eq!(node_1_chan_update.contents.htlc_maximum_msat, channel_value_30_percent_msat);
7667
7668         // Assert that `node[2]`'s `ChannelUpdate` is capped at 90 percent of the `channel_value`, as
7669         // the value of `node[3]`'s `holder_max_htlc_value_in_flight_msat` (100%), exceeds 90% of the
7670         // `channel_value`.
7671         assert_eq!(node_2_chan_update.contents.htlc_maximum_msat, channel_value_90_percent_msat);
7672         // Assert that `node[3]`'s `ChannelUpdate` is capped at 90 percent of the `channel_value`, as
7673         // the value of `node[2]`'s `holder_max_htlc_value_in_flight_msat` (95%), exceeds 90% of the
7674         // `channel_value`.
7675         assert_eq!(node_3_chan_update.contents.htlc_maximum_msat, channel_value_90_percent_msat);
7676 }
7677
7678 #[test]
7679 fn test_manually_accept_inbound_channel_request() {
7680         let mut manually_accept_conf = UserConfig::default();
7681         manually_accept_conf.manually_accept_inbound_channels = true;
7682         let chanmon_cfgs = create_chanmon_cfgs(2);
7683         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7684         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
7685         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7686
7687         let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(manually_accept_conf)).unwrap();
7688         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7689
7690         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &res);
7691
7692         // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in `msg_events` before
7693         // accepting the inbound channel request.
7694         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7695
7696         let events = nodes[1].node.get_and_clear_pending_events();
7697         match events[0] {
7698                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
7699                         nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 23).unwrap();
7700                 }
7701                 _ => panic!("Unexpected event"),
7702         }
7703
7704         let accept_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7705         assert_eq!(accept_msg_ev.len(), 1);
7706
7707         match accept_msg_ev[0] {
7708                 MessageSendEvent::SendAcceptChannel { ref node_id, .. } => {
7709                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7710                 }
7711                 _ => panic!("Unexpected event"),
7712         }
7713
7714         nodes[1].node.force_close_broadcasting_latest_txn(&temp_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
7715
7716         let close_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7717         assert_eq!(close_msg_ev.len(), 1);
7718
7719         let events = nodes[1].node.get_and_clear_pending_events();
7720         match events[0] {
7721                 Event::ChannelClosed { user_channel_id, .. } => {
7722                         assert_eq!(user_channel_id, 23);
7723                 }
7724                 _ => panic!("Unexpected event"),
7725         }
7726 }
7727
7728 #[test]
7729 fn test_manually_reject_inbound_channel_request() {
7730         let mut manually_accept_conf = UserConfig::default();
7731         manually_accept_conf.manually_accept_inbound_channels = true;
7732         let chanmon_cfgs = create_chanmon_cfgs(2);
7733         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7734         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
7735         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7736
7737         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(manually_accept_conf)).unwrap();
7738         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7739
7740         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &res);
7741
7742         // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in `msg_events` before
7743         // rejecting the inbound channel request.
7744         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7745
7746         let events = nodes[1].node.get_and_clear_pending_events();
7747         match events[0] {
7748                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
7749                         nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
7750                 }
7751                 _ => panic!("Unexpected event"),
7752         }
7753
7754         let close_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7755         assert_eq!(close_msg_ev.len(), 1);
7756
7757         match close_msg_ev[0] {
7758                 MessageSendEvent::HandleError { ref node_id, .. } => {
7759                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7760                 }
7761                 _ => panic!("Unexpected event"),
7762         }
7763         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
7764 }
7765
7766 #[test]
7767 fn test_reject_funding_before_inbound_channel_accepted() {
7768         // This tests that when `UserConfig::manually_accept_inbound_channels` is set to true, inbound
7769         // channels must to be manually accepted through `ChannelManager::accept_inbound_channel` by
7770         // the node operator before the counterparty sends a `FundingCreated` message. If a
7771         // `FundingCreated` message is received before the channel is accepted, it should be rejected
7772         // and the channel should be closed.
7773         let mut manually_accept_conf = UserConfig::default();
7774         manually_accept_conf.manually_accept_inbound_channels = true;
7775         let chanmon_cfgs = create_chanmon_cfgs(2);
7776         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7777         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
7778         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7779
7780         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(manually_accept_conf)).unwrap();
7781         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7782         let temp_channel_id = res.temporary_channel_id;
7783
7784         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &res);
7785
7786         // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in the `msg_events`.
7787         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7788
7789         // Clear the `Event::OpenChannelRequest` event without responding to the request.
7790         nodes[1].node.get_and_clear_pending_events();
7791
7792         // Get the `AcceptChannel` message of `nodes[1]` without calling
7793         // `ChannelManager::accept_inbound_channel`, which generates a
7794         // `MessageSendEvent::SendAcceptChannel` event. The message is passed to `nodes[0]`
7795         // `handle_accept_channel`, which is required in order for `create_funding_transaction` to
7796         // succeed when `nodes[0]` is passed to it.
7797         let accept_chan_msg = {
7798                 let mut lock;
7799                 let channel = get_channel_ref!(&nodes[1], lock, temp_channel_id);
7800                 channel.get_accept_channel_message()
7801         };
7802         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_chan_msg);
7803
7804         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
7805
7806         nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
7807         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
7808
7809         // The `funding_created_msg` should be rejected by `nodes[1]` as it hasn't accepted the channel
7810         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
7811
7812         let close_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7813         assert_eq!(close_msg_ev.len(), 1);
7814
7815         let expected_err = "FundingCreated message received before the channel was accepted";
7816         match close_msg_ev[0] {
7817                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, ref node_id, } => {
7818                         assert_eq!(msg.channel_id, temp_channel_id);
7819                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7820                         assert_eq!(msg.data, expected_err);
7821                 }
7822                 _ => panic!("Unexpected event"),
7823         }
7824
7825         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: expected_err.to_string() });
7826 }
7827
7828 #[test]
7829 fn test_can_not_accept_inbound_channel_twice() {
7830         let mut manually_accept_conf = UserConfig::default();
7831         manually_accept_conf.manually_accept_inbound_channels = true;
7832         let chanmon_cfgs = create_chanmon_cfgs(2);
7833         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7834         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(manually_accept_conf.clone())]);
7835         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7836
7837         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, Some(manually_accept_conf)).unwrap();
7838         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7839
7840         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &res);
7841
7842         // Assert that `nodes[1]` has no `MessageSendEvent::SendAcceptChannel` in `msg_events` before
7843         // accepting the inbound channel request.
7844         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7845
7846         let events = nodes[1].node.get_and_clear_pending_events();
7847         match events[0] {
7848                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
7849                         nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0).unwrap();
7850                         let api_res = nodes[1].node.accept_inbound_channel(&temporary_channel_id, &nodes[0].node.get_our_node_id(), 0);
7851                         match api_res {
7852                                 Err(APIError::APIMisuseError { err }) => {
7853                                         assert_eq!(err, "The channel isn't currently awaiting to be accepted.");
7854                                 },
7855                                 Ok(_) => panic!("Channel shouldn't be possible to be accepted twice"),
7856                                 Err(_) => panic!("Unexpected Error"),
7857                         }
7858                 }
7859                 _ => panic!("Unexpected event"),
7860         }
7861
7862         // Ensure that the channel wasn't closed after attempting to accept it twice.
7863         let accept_msg_ev = nodes[1].node.get_and_clear_pending_msg_events();
7864         assert_eq!(accept_msg_ev.len(), 1);
7865
7866         match accept_msg_ev[0] {
7867                 MessageSendEvent::SendAcceptChannel { ref node_id, .. } => {
7868                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7869                 }
7870                 _ => panic!("Unexpected event"),
7871         }
7872 }
7873
7874 #[test]
7875 fn test_can_not_accept_unknown_inbound_channel() {
7876         let chanmon_cfg = create_chanmon_cfgs(2);
7877         let node_cfg = create_node_cfgs(2, &chanmon_cfg);
7878         let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
7879         let nodes = create_network(2, &node_cfg, &node_chanmgr);
7880
7881         let unknown_channel_id = [0; 32];
7882         let api_res = nodes[0].node.accept_inbound_channel(&unknown_channel_id, &nodes[1].node.get_our_node_id(), 0);
7883         match api_res {
7884                 Err(APIError::ChannelUnavailable { err }) => {
7885                         assert_eq!(err, "Can't accept a channel that doesn't exist");
7886                 },
7887                 Ok(_) => panic!("It shouldn't be possible to accept an unkown channel"),
7888                 Err(_) => panic!("Unexpected Error"),
7889         }
7890 }
7891
7892 #[test]
7893 fn test_simple_mpp() {
7894         // Simple test of sending a multi-path payment.
7895         let chanmon_cfgs = create_chanmon_cfgs(4);
7896         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7897         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7898         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7899
7900         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7901         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7902         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7903         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7904
7905         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
7906         let path = route.paths[0].clone();
7907         route.paths.push(path);
7908         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7909         route.paths[0][0].short_channel_id = chan_1_id;
7910         route.paths[0][1].short_channel_id = chan_3_id;
7911         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7912         route.paths[1][0].short_channel_id = chan_2_id;
7913         route.paths[1][1].short_channel_id = chan_4_id;
7914         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
7915         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
7916 }
7917
7918 #[test]
7919 fn test_preimage_storage() {
7920         // Simple test of payment preimage storage allowing no client-side storage to claim payments
7921         let chanmon_cfgs = create_chanmon_cfgs(2);
7922         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7923         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7924         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7925
7926         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7927
7928         {
7929                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200).unwrap();
7930                 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
7931                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
7932                 check_added_monitors!(nodes[0], 1);
7933                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7934                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7935                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7936                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7937         }
7938         // Note that after leaving the above scope we have no knowledge of any arguments or return
7939         // values from previous calls.
7940         expect_pending_htlcs_forwardable!(nodes[1]);
7941         let events = nodes[1].node.get_and_clear_pending_events();
7942         assert_eq!(events.len(), 1);
7943         match events[0] {
7944                 Event::PaymentReceived { ref purpose, .. } => {
7945                         match &purpose {
7946                                 PaymentPurpose::InvoicePayment { payment_preimage, .. } => {
7947                                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
7948                                 },
7949                                 _ => panic!("expected PaymentPurpose::InvoicePayment")
7950                         }
7951                 },
7952                 _ => panic!("Unexpected event"),
7953         }
7954 }
7955
7956 #[test]
7957 #[allow(deprecated)]
7958 fn test_secret_timeout() {
7959         // Simple test of payment secret storage time outs. After
7960         // `create_inbound_payment(_for_hash)_legacy` is removed, this test will be removed as well.
7961         let chanmon_cfgs = create_chanmon_cfgs(2);
7962         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7963         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7964         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7965
7966         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
7967
7968         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment_legacy(Some(100_000), 2).unwrap();
7969
7970         // We should fail to register the same payment hash twice, at least until we've connected a
7971         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
7972         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash_legacy(payment_hash, Some(100_000), 2) {
7973                 assert_eq!(err, "Duplicate payment hash");
7974         } else { panic!(); }
7975         let mut block = {
7976                 let node_1_blocks = nodes[1].blocks.lock().unwrap();
7977                 Block {
7978                         header: BlockHeader {
7979                                 version: 0x2000000,
7980                                 prev_blockhash: node_1_blocks.last().unwrap().0.block_hash(),
7981                                 merkle_root: TxMerkleNode::all_zeros(),
7982                                 time: node_1_blocks.len() as u32 + 7200, bits: 42, nonce: 42 },
7983                         txdata: vec![],
7984                 }
7985         };
7986         connect_block(&nodes[1], &block);
7987         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash_legacy(payment_hash, Some(100_000), 2) {
7988                 assert_eq!(err, "Duplicate payment hash");
7989         } else { panic!(); }
7990
7991         // If we then connect the second block, we should be able to register the same payment hash
7992         // again (this time getting a new payment secret).
7993         block.header.prev_blockhash = block.header.block_hash();
7994         block.header.time += 1;
7995         connect_block(&nodes[1], &block);
7996         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash_legacy(payment_hash, Some(100_000), 2).unwrap();
7997         assert_ne!(payment_secret_1, our_payment_secret);
7998
7999         {
8000                 let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
8001                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret), PaymentId(payment_hash.0)).unwrap();
8002                 check_added_monitors!(nodes[0], 1);
8003                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8004                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8005                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8006                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8007         }
8008         // Note that after leaving the above scope we have no knowledge of any arguments or return
8009         // values from previous calls.
8010         expect_pending_htlcs_forwardable!(nodes[1]);
8011         let events = nodes[1].node.get_and_clear_pending_events();
8012         assert_eq!(events.len(), 1);
8013         match events[0] {
8014                 Event::PaymentReceived { purpose: PaymentPurpose::InvoicePayment { payment_preimage, payment_secret }, .. } => {
8015                         assert!(payment_preimage.is_none());
8016                         assert_eq!(payment_secret, our_payment_secret);
8017                         // We don't actually have the payment preimage with which to claim this payment!
8018                 },
8019                 _ => panic!("Unexpected event"),
8020         }
8021 }
8022
8023 #[test]
8024 fn test_bad_secret_hash() {
8025         // Simple test of unregistered payment hash/invalid payment secret handling
8026         let chanmon_cfgs = create_chanmon_cfgs(2);
8027         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8028         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8029         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8030
8031         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
8032
8033         let random_payment_hash = PaymentHash([42; 32]);
8034         let random_payment_secret = PaymentSecret([43; 32]);
8035         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2).unwrap();
8036         let (route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
8037
8038         // All the below cases should end up being handled exactly identically, so we macro the
8039         // resulting events.
8040         macro_rules! handle_unknown_invalid_payment_data {
8041                 ($payment_hash: expr) => {
8042                         check_added_monitors!(nodes[0], 1);
8043                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8044                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8045                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8046                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8047
8048                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8049                         // again to process the pending backwards-failure of the HTLC
8050                         expect_pending_htlcs_forwardable!(nodes[1]);
8051                         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment{ payment_hash: $payment_hash }]);
8052                         check_added_monitors!(nodes[1], 1);
8053
8054                         // We should fail the payment back
8055                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8056                         match events.pop().unwrap() {
8057                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8058                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8059                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8060                                 },
8061                                 _ => panic!("Unexpected event"),
8062                         }
8063                 }
8064         }
8065
8066         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8067         // Error data is the HTLC value (100,000) and current block height
8068         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8069
8070         // Send a payment with the right payment hash but the wrong payment secret
8071         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
8072         handle_unknown_invalid_payment_data!(our_payment_hash);
8073         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8074
8075         // Send a payment with a random payment hash, but the right payment secret
8076         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret), PaymentId(random_payment_hash.0)).unwrap();
8077         handle_unknown_invalid_payment_data!(random_payment_hash);
8078         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8079
8080         // Send a payment with a random payment hash and random payment secret
8081         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret), PaymentId(random_payment_hash.0)).unwrap();
8082         handle_unknown_invalid_payment_data!(random_payment_hash);
8083         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8084 }
8085
8086 #[test]
8087 fn test_update_err_monitor_lockdown() {
8088         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8089         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8090         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateStatus
8091         // error.
8092         //
8093         // This scenario may happen in a watchtower setup, where watchtower process a block height
8094         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8095         // commitment at same time.
8096
8097         let chanmon_cfgs = create_chanmon_cfgs(2);
8098         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8099         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8100         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8101
8102         // Create some initial channel
8103         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8104         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8105
8106         // Rebalance the network to generate htlc in the two directions
8107         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8108
8109         // Route a HTLC from node 0 to node 1 (but don't settle)
8110         let (preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 9_000_000);
8111
8112         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8113         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8114         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8115         let persister = test_utils::TestPersister::new();
8116         let watchtower = {
8117                 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8118                 let mut w = test_utils::TestVecWriter(Vec::new());
8119                 monitor.write(&mut w).unwrap();
8120                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8121                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8122                 assert!(new_monitor == *monitor);
8123                 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);
8124                 assert_eq!(watchtower.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
8125                 watchtower
8126         };
8127         let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8128         let block = Block { header, txdata: vec![] };
8129         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8130         // transaction lock time requirements here.
8131         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize(200, (block.clone(), 0));
8132         watchtower.chain_monitor.block_connected(&block, 200);
8133
8134         // Try to update ChannelMonitor
8135         nodes[1].node.claim_funds(preimage);
8136         check_added_monitors!(nodes[1], 1);
8137         expect_payment_claimed!(nodes[1], payment_hash, 9_000_000);
8138
8139         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8140         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8141         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8142         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8143                 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8144                         assert_eq!(watchtower.chain_monitor.update_channel(outpoint, update.clone()), ChannelMonitorUpdateStatus::PermanentFailure);
8145                         assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, update), ChannelMonitorUpdateStatus::Completed);
8146                 } else { assert!(false); }
8147         } else { assert!(false); };
8148         // Our local monitor is in-sync and hasn't processed yet timeout
8149         check_added_monitors!(nodes[0], 1);
8150         let events = nodes[0].node.get_and_clear_pending_events();
8151         assert_eq!(events.len(), 1);
8152 }
8153
8154 #[test]
8155 fn test_concurrent_monitor_claim() {
8156         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8157         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8158         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8159         // state N+1 confirms. Alice claims output from state N+1.
8160
8161         let chanmon_cfgs = create_chanmon_cfgs(2);
8162         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8163         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8164         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8165
8166         // Create some initial channel
8167         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8168         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8169
8170         // Rebalance the network to generate htlc in the two directions
8171         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8172
8173         // Route a HTLC from node 0 to node 1 (but don't settle)
8174         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8175
8176         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8177         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8178         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8179         let persister = test_utils::TestPersister::new();
8180         let watchtower_alice = {
8181                 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8182                 let mut w = test_utils::TestVecWriter(Vec::new());
8183                 monitor.write(&mut w).unwrap();
8184                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8185                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8186                 assert!(new_monitor == *monitor);
8187                 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);
8188                 assert_eq!(watchtower.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
8189                 watchtower
8190         };
8191         let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8192         let block = Block { header, txdata: vec![] };
8193         // Make the tx_broadcaster aware of enough blocks that it doesn't think we're violating
8194         // transaction lock time requirements here.
8195         chanmon_cfgs[0].tx_broadcaster.blocks.lock().unwrap().resize((CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS) as usize, (block.clone(), 0));
8196         watchtower_alice.chain_monitor.block_connected(&block, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8197
8198         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8199         {
8200                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8201                 assert_eq!(txn.len(), 2);
8202                 txn.clear();
8203         }
8204
8205         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8206         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8207         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8208         let persister = test_utils::TestPersister::new();
8209         let watchtower_bob = {
8210                 let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
8211                 let mut w = test_utils::TestVecWriter(Vec::new());
8212                 monitor.write(&mut w).unwrap();
8213                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8214                                 &mut io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8215                 assert!(new_monitor == *monitor);
8216                 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);
8217                 assert_eq!(watchtower.watch_channel(outpoint, new_monitor), ChannelMonitorUpdateStatus::Completed);
8218                 watchtower
8219         };
8220         let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8221         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8222
8223         // Route another payment to generate another update with still previous HTLC pending
8224         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 3000000);
8225         {
8226                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8227         }
8228         check_added_monitors!(nodes[1], 1);
8229
8230         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8231         assert_eq!(updates.update_add_htlcs.len(), 1);
8232         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8233         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8234                 if let Ok((_, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].logger) {
8235                         // Watchtower Alice should already have seen the block and reject the update
8236                         assert_eq!(watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()), ChannelMonitorUpdateStatus::PermanentFailure);
8237                         assert_eq!(watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()), ChannelMonitorUpdateStatus::Completed);
8238                         assert_eq!(nodes[0].chain_monitor.update_channel(outpoint, update), ChannelMonitorUpdateStatus::Completed);
8239                 } else { assert!(false); }
8240         } else { assert!(false); };
8241         // Our local monitor is in-sync and hasn't processed yet timeout
8242         check_added_monitors!(nodes[0], 1);
8243
8244         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8245         let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8246         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8247
8248         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8249         let bob_state_y;
8250         {
8251                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8252                 assert_eq!(txn.len(), 2);
8253                 bob_state_y = txn[0].clone();
8254                 txn.clear();
8255         };
8256
8257         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8258         let header = BlockHeader { version: 0x20000000, prev_blockhash: BlockHash::all_zeros(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8259         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);
8260         {
8261                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8262                 assert_eq!(htlc_txn.len(), 1);
8263                 check_spends!(htlc_txn[0], bob_state_y);
8264         }
8265 }
8266
8267 #[test]
8268 fn test_pre_lockin_no_chan_closed_update() {
8269         // Test that if a peer closes a channel in response to a funding_created message we don't
8270         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8271         // message).
8272         //
8273         // Doing so would imply a channel monitor update before the initial channel monitor
8274         // registration, violating our API guarantees.
8275         //
8276         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8277         // then opening a second channel with the same funding output as the first (which is not
8278         // rejected because the first channel does not exist in the ChannelManager) and closing it
8279         // before receiving funding_signed.
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 an initial channel
8286         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8287         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8288         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_chan_msg);
8289         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8290         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_chan_msg);
8291
8292         // Move the first channel through the funding flow...
8293         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
8294
8295         nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8296         check_added_monitors!(nodes[0], 0);
8297
8298         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8299         let channel_id = crate::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8300         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8301         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8302         check_closed_event!(nodes[0], 2, ClosureReason::CounterpartyForceClosed { peer_msg: "Hi".to_string() }, true);
8303 }
8304
8305 #[test]
8306 fn test_htlc_no_detection() {
8307         // This test is a mutation to underscore the detection logic bug we had
8308         // before #653. HTLC value routed is above the remaining balance, thus
8309         // inverting HTLC and `to_remote` output. HTLC will come second and
8310         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8311         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8312         // outputs order detection for correct spending children filtring.
8313
8314         let chanmon_cfgs = create_chanmon_cfgs(2);
8315         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8316         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8317         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8318
8319         // Create some initial channels
8320         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8321
8322         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8323         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8324         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8325         assert_eq!(local_txn[0].input.len(), 1);
8326         assert_eq!(local_txn[0].output.len(), 3);
8327         check_spends!(local_txn[0], chan_1.3);
8328
8329         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8330         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8331         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8332         // We deliberately connect the local tx twice as this should provoke a failure calling
8333         // this test before #653 fix.
8334         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);
8335         check_closed_broadcast!(nodes[0], true);
8336         check_added_monitors!(nodes[0], 1);
8337         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
8338         connect_blocks(&nodes[0], TEST_FINAL_CLTV - 1);
8339
8340         let htlc_timeout = {
8341                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8342                 assert_eq!(node_txn[1].input.len(), 1);
8343                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8344                 check_spends!(node_txn[1], local_txn[0]);
8345                 node_txn[1].clone()
8346         };
8347
8348         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
8349         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8350         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8351         expect_payment_failed!(nodes[0], our_payment_hash, false);
8352 }
8353
8354 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8355         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8356         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8357         // Carol, Alice would be the upstream node, and Carol the downstream.)
8358         //
8359         // Steps of the test:
8360         // 1) Alice sends a HTLC to Carol through Bob.
8361         // 2) Carol doesn't settle the HTLC.
8362         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8363         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8364         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8365         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8366         // 5) Carol release the preimage to Bob off-chain.
8367         // 6) Bob claims the offered output on the broadcasted commitment.
8368         let chanmon_cfgs = create_chanmon_cfgs(3);
8369         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8370         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8371         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8372
8373         // Create some initial channels
8374         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8375         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8376
8377         // Steps (1) and (2):
8378         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8379         let (payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3_000_000);
8380
8381         // Check that Alice's commitment transaction now contains an output for this HTLC.
8382         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8383         check_spends!(alice_txn[0], chan_ab.3);
8384         assert_eq!(alice_txn[0].output.len(), 2);
8385         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8386         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8387         assert_eq!(alice_txn.len(), 2);
8388
8389         // Steps (3) and (4):
8390         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8391         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8392         let mut force_closing_node = 0; // Alice force-closes
8393         let mut counterparty_node = 1; // Bob if Alice force-closes
8394
8395         // Bob force-closes
8396         if !broadcast_alice {
8397                 force_closing_node = 1;
8398                 counterparty_node = 0;
8399         }
8400         nodes[force_closing_node].node.force_close_broadcasting_latest_txn(&chan_ab.2, &nodes[counterparty_node].node.get_our_node_id()).unwrap();
8401         check_closed_broadcast!(nodes[force_closing_node], true);
8402         check_added_monitors!(nodes[force_closing_node], 1);
8403         check_closed_event!(nodes[force_closing_node], 1, ClosureReason::HolderForceClosed);
8404         if go_onchain_before_fulfill {
8405                 let txn_to_broadcast = match broadcast_alice {
8406                         true => alice_txn.clone(),
8407                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8408                 };
8409                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
8410                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8411                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8412                 if broadcast_alice {
8413                         check_closed_broadcast!(nodes[1], true);
8414                         check_added_monitors!(nodes[1], 1);
8415                         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
8416                 }
8417                 assert_eq!(bob_txn.len(), 1);
8418                 check_spends!(bob_txn[0], chan_ab.3);
8419         }
8420
8421         // Step (5):
8422         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8423         // process of removing the HTLC from their commitment transactions.
8424         nodes[2].node.claim_funds(payment_preimage);
8425         check_added_monitors!(nodes[2], 1);
8426         expect_payment_claimed!(nodes[2], payment_hash, 3_000_000);
8427
8428         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8429         assert!(carol_updates.update_add_htlcs.is_empty());
8430         assert!(carol_updates.update_fail_htlcs.is_empty());
8431         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8432         assert!(carol_updates.update_fee.is_none());
8433         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8434
8435         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8436         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], if go_onchain_before_fulfill || force_closing_node == 1 { None } else { Some(1000) }, false, false);
8437         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8438         if !go_onchain_before_fulfill && broadcast_alice {
8439                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8440                 assert_eq!(events.len(), 1);
8441                 match events[0] {
8442                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8443                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8444                         },
8445                         _ => panic!("Unexpected event"),
8446                 };
8447         }
8448         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8449         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8450         // Carol<->Bob's updated commitment transaction info.
8451         check_added_monitors!(nodes[1], 2);
8452
8453         let events = nodes[1].node.get_and_clear_pending_msg_events();
8454         assert_eq!(events.len(), 2);
8455         let bob_revocation = match events[0] {
8456                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8457                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8458                         (*msg).clone()
8459                 },
8460                 _ => panic!("Unexpected event"),
8461         };
8462         let bob_updates = match events[1] {
8463                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8464                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8465                         (*updates).clone()
8466                 },
8467                 _ => panic!("Unexpected event"),
8468         };
8469
8470         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8471         check_added_monitors!(nodes[2], 1);
8472         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8473         check_added_monitors!(nodes[2], 1);
8474
8475         let events = nodes[2].node.get_and_clear_pending_msg_events();
8476         assert_eq!(events.len(), 1);
8477         let carol_revocation = match events[0] {
8478                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8479                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8480                         (*msg).clone()
8481                 },
8482                 _ => panic!("Unexpected event"),
8483         };
8484         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8485         check_added_monitors!(nodes[1], 1);
8486
8487         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8488         // here's where we put said channel's commitment tx on-chain.
8489         let mut txn_to_broadcast = alice_txn.clone();
8490         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8491         if !go_onchain_before_fulfill {
8492                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42};
8493                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8494                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8495                 if broadcast_alice {
8496                         check_closed_broadcast!(nodes[1], true);
8497                         check_added_monitors!(nodes[1], 1);
8498                         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
8499                 }
8500                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8501                 if broadcast_alice {
8502                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8503                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8504                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8505                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8506                         // broadcasted.
8507                         assert_eq!(bob_txn.len(), 3);
8508                         check_spends!(bob_txn[1], chan_ab.3);
8509                 } else {
8510                         assert_eq!(bob_txn.len(), 2);
8511                         check_spends!(bob_txn[0], chan_ab.3);
8512                 }
8513         }
8514
8515         // Step (6):
8516         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8517         // broadcasted commitment transaction.
8518         {
8519                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8520                 if go_onchain_before_fulfill {
8521                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8522                         assert_eq!(bob_txn.len(), 2);
8523                 }
8524                 let script_weight = match broadcast_alice {
8525                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8526                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8527                 };
8528                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8529                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8530                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8531                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8532                 if broadcast_alice && !go_onchain_before_fulfill {
8533                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8534                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8535                 } else {
8536                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8537                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8538                 }
8539         }
8540 }
8541
8542 #[test]
8543 fn test_onchain_htlc_settlement_after_close() {
8544         do_test_onchain_htlc_settlement_after_close(true, true);
8545         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8546         do_test_onchain_htlc_settlement_after_close(true, false);
8547         do_test_onchain_htlc_settlement_after_close(false, false);
8548 }
8549
8550 #[test]
8551 fn test_duplicate_chan_id() {
8552         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8553         // already open we reject it and keep the old channel.
8554         //
8555         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8556         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8557         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8558         // updating logic for the existing channel.
8559         let chanmon_cfgs = create_chanmon_cfgs(2);
8560         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8561         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8562         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8563
8564         // Create an initial channel
8565         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8566         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8567         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_chan_msg);
8568         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8569
8570         // Try to create a second channel with the same temporary_channel_id as the first and check
8571         // that it is rejected.
8572         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_chan_msg);
8573         {
8574                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8575                 assert_eq!(events.len(), 1);
8576                 match events[0] {
8577                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8578                                 // Technically, at this point, nodes[1] would be justified in thinking both the
8579                                 // first (valid) and second (invalid) channels are closed, given they both have
8580                                 // the same non-temporary channel_id. However, currently we do not, so we just
8581                                 // move forward with it.
8582                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8583                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8584                         },
8585                         _ => panic!("Unexpected event"),
8586                 }
8587         }
8588
8589         // Move the first channel through the funding flow...
8590         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42);
8591
8592         nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8593         check_added_monitors!(nodes[0], 0);
8594
8595         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8596         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8597         {
8598                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8599                 assert_eq!(added_monitors.len(), 1);
8600                 assert_eq!(added_monitors[0].0, funding_output);
8601                 added_monitors.clear();
8602         }
8603         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8604
8605         let funding_outpoint = crate::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8606         let channel_id = funding_outpoint.to_channel_id();
8607
8608         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8609         // temporary one).
8610
8611         // First try to open a second channel with a temporary channel id equal to the txid-based one.
8612         // Technically this is allowed by the spec, but we don't support it and there's little reason
8613         // to. Still, it shouldn't cause any other issues.
8614         open_chan_msg.temporary_channel_id = channel_id;
8615         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_chan_msg);
8616         {
8617                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8618                 assert_eq!(events.len(), 1);
8619                 match events[0] {
8620                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8621                                 // Technically, at this point, nodes[1] would be justified in thinking both
8622                                 // channels are closed, but currently we do not, so we just move forward with it.
8623                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8624                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8625                         },
8626                         _ => panic!("Unexpected event"),
8627                 }
8628         }
8629
8630         // Now try to create a second channel which has a duplicate funding output.
8631         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8632         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8633         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_chan_2_msg);
8634         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8635         create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100000, 42); // Get and check the FundingGenerationReady event
8636
8637         let funding_created = {
8638                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8639                 // Once we call `get_outbound_funding_created` the channel has a duplicate channel_id as
8640                 // another channel in the ChannelManager - an invalid state. Thus, we'd panic later when we
8641                 // try to create another channel. Instead, we drop the channel entirely here (leaving the
8642                 // channelmanager in a possibly nonsense state instead).
8643                 let mut as_chan = a_channel_lock.by_id.remove(&open_chan_2_msg.temporary_channel_id).unwrap();
8644                 let logger = test_utils::TestLogger::new();
8645                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8646         };
8647         check_added_monitors!(nodes[0], 0);
8648         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8649         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8650         // still needs to be cleared here.
8651         check_added_monitors!(nodes[1], 1);
8652
8653         // ...still, nodes[1] will reject the duplicate channel.
8654         {
8655                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8656                 assert_eq!(events.len(), 1);
8657                 match events[0] {
8658                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8659                                 // Technically, at this point, nodes[1] would be justified in thinking both
8660                                 // channels are closed, but currently we do not, so we just move forward with it.
8661                                 assert_eq!(msg.channel_id, channel_id);
8662                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8663                         },
8664                         _ => panic!("Unexpected event"),
8665                 }
8666         }
8667
8668         // finally, finish creating the original channel and send a payment over it to make sure
8669         // everything is functional.
8670         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8671         {
8672                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8673                 assert_eq!(added_monitors.len(), 1);
8674                 assert_eq!(added_monitors[0].0, funding_output);
8675                 added_monitors.clear();
8676         }
8677
8678         let events_4 = nodes[0].node.get_and_clear_pending_events();
8679         assert_eq!(events_4.len(), 0);
8680         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8681         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8682
8683         let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8684         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
8685         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8686
8687         send_payment(&nodes[0], &[&nodes[1]], 8000000);
8688 }
8689
8690 #[test]
8691 fn test_error_chans_closed() {
8692         // Test that we properly handle error messages, closing appropriate channels.
8693         //
8694         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8695         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8696         // we can test various edge cases around it to ensure we don't regress.
8697         let chanmon_cfgs = create_chanmon_cfgs(3);
8698         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8699         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8700         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8701
8702         // Create some initial channels
8703         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8704         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8705         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8706
8707         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8708         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8709         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8710
8711         // Closing a channel from a different peer has no effect
8712         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8713         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8714
8715         // Closing one channel doesn't impact others
8716         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8717         check_added_monitors!(nodes[0], 1);
8718         check_closed_broadcast!(nodes[0], false);
8719         check_closed_event!(nodes[0], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
8720         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
8721         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8722         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);
8723         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);
8724
8725         // A null channel ID should close all channels
8726         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8727         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8728         check_added_monitors!(nodes[0], 2);
8729         check_closed_event!(nodes[0], 2, ClosureReason::CounterpartyForceClosed { peer_msg: "ERR".to_string() });
8730         let events = nodes[0].node.get_and_clear_pending_msg_events();
8731         assert_eq!(events.len(), 2);
8732         match events[0] {
8733                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8734                         assert_eq!(msg.contents.flags & 2, 2);
8735                 },
8736                 _ => panic!("Unexpected event"),
8737         }
8738         match events[1] {
8739                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8740                         assert_eq!(msg.contents.flags & 2, 2);
8741                 },
8742                 _ => panic!("Unexpected event"),
8743         }
8744         // Note that at this point users of a standard PeerHandler will end up calling
8745         // peer_disconnected with no_connection_possible set to false, duplicating the
8746         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8747         // users with their own peer handling logic. We duplicate the call here, however.
8748         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8749         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8750
8751         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8752         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8753         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8754 }
8755
8756 #[test]
8757 fn test_invalid_funding_tx() {
8758         // Test that we properly handle invalid funding transactions sent to us from a peer.
8759         //
8760         // Previously, all other major lightning implementations had failed to properly sanitize
8761         // funding transactions from their counterparties, leading to a multi-implementation critical
8762         // security vulnerability (though we always sanitized properly, we've previously had
8763         // un-released crashes in the sanitization process).
8764         //
8765         // Further, if the funding transaction is consensus-valid, confirms, and is later spent, we'd
8766         // previously have crashed in `ChannelMonitor` even though we closed the channel as bogus and
8767         // gave up on it. We test this here by generating such a transaction.
8768         let chanmon_cfgs = create_chanmon_cfgs(2);
8769         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8770         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8771         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8772
8773         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
8774         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
8775         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8776
8777         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 100_000, 42);
8778
8779         // Create a witness program which can be spent by a 4-empty-stack-elements witness and which is
8780         // 136 bytes long. This matches our "accepted HTLC preimage spend" matching, previously causing
8781         // a panic as we'd try to extract a 32 byte preimage from a witness element without checking
8782         // its length.
8783         let mut wit_program: Vec<u8> = channelmonitor::deliberately_bogus_accepted_htlc_witness_program();
8784         let wit_program_script: Script = wit_program.into();
8785         for output in tx.output.iter_mut() {
8786                 // Make the confirmed funding transaction have a bogus script_pubkey
8787                 output.script_pubkey = Script::new_v0_p2wsh(&wit_program_script.wscript_hash());
8788         }
8789
8790         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone(), 0).unwrap();
8791         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()));
8792         check_added_monitors!(nodes[1], 1);
8793
8794         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()));
8795         check_added_monitors!(nodes[0], 1);
8796
8797         let events_1 = nodes[0].node.get_and_clear_pending_events();
8798         assert_eq!(events_1.len(), 0);
8799
8800         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8801         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8802         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
8803
8804         let expected_err = "funding tx had wrong script/value or output index";
8805         confirm_transaction_at(&nodes[1], &tx, 1);
8806         check_closed_event!(nodes[1], 1, ClosureReason::ProcessingError { err: expected_err.to_string() });
8807         check_added_monitors!(nodes[1], 1);
8808         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
8809         assert_eq!(events_2.len(), 1);
8810         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
8811                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8812                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
8813                         assert_eq!(msg.data, "Channel closed because of an exception: ".to_owned() + expected_err);
8814                 } else { panic!(); }
8815         } else { panic!(); }
8816         assert_eq!(nodes[1].node.list_channels().len(), 0);
8817
8818         // Now confirm a spend of the (bogus) funding transaction. As long as the witness is 5 elements
8819         // long the ChannelMonitor will try to read 32 bytes from the second-to-last element, panicing
8820         // as its not 32 bytes long.
8821         let mut spend_tx = Transaction {
8822                 version: 2i32, lock_time: PackedLockTime::ZERO,
8823                 input: tx.output.iter().enumerate().map(|(idx, _)| TxIn {
8824                         previous_output: BitcoinOutPoint {
8825                                 txid: tx.txid(),
8826                                 vout: idx as u32,
8827                         },
8828                         script_sig: Script::new(),
8829                         sequence: Sequence::ENABLE_RBF_NO_LOCKTIME,
8830                         witness: Witness::from_vec(channelmonitor::deliberately_bogus_accepted_htlc_witness())
8831                 }).collect(),
8832                 output: vec![TxOut {
8833                         value: 1000,
8834                         script_pubkey: Script::new(),
8835                 }]
8836         };
8837         check_spends!(spend_tx, tx);
8838         mine_transaction(&nodes[1], &spend_tx);
8839 }
8840
8841 fn do_test_tx_confirmed_skipping_blocks_immediate_broadcast(test_height_before_timelock: bool) {
8842         // In the first version of the chain::Confirm interface, after a refactor was made to not
8843         // broadcast CSV-locked transactions until their CSV lock is up, we wouldn't reliably broadcast
8844         // transactions after a `transactions_confirmed` call. Specifically, if the chain, provided via
8845         // `best_block_updated` is at height N, and a transaction output which we wish to spend at
8846         // height N-1 (due to a CSV to height N-1) is provided at height N, we will not broadcast the
8847         // spending transaction until height N+1 (or greater). This was due to the way
8848         // `ChannelMonitor::transactions_confirmed` worked, only checking if we should broadcast a
8849         // spending transaction at the height the input transaction was confirmed at, not whether we
8850         // should broadcast a spending transaction at the current height.
8851         // A second, similar, issue involved failing HTLCs backwards - because we only provided the
8852         // height at which transactions were confirmed to `OnchainTx::update_claims_view`, it wasn't
8853         // aware that the anti-reorg-delay had, in fact, already expired, waiting to fail-backwards
8854         // until we learned about an additional block.
8855         //
8856         // As an additional check, if `test_height_before_timelock` is set, we instead test that we
8857         // aren't broadcasting transactions too early (ie not broadcasting them at all).
8858         let chanmon_cfgs = create_chanmon_cfgs(3);
8859         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8860         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8861         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8862         *nodes[0].connect_style.borrow_mut() = ConnectStyle::BestBlockFirstSkippingBlocks;
8863
8864         create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8865         let (chan_announce, _, channel_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8866         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
8867         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
8868         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8869
8870         nodes[1].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[2].node.get_our_node_id()).unwrap();
8871         check_closed_broadcast!(nodes[1], true);
8872         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
8873         check_added_monitors!(nodes[1], 1);
8874         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
8875         assert_eq!(node_txn.len(), 1);
8876
8877         let conf_height = nodes[1].best_block_info().1;
8878         if !test_height_before_timelock {
8879                 connect_blocks(&nodes[1], 24 * 6);
8880         }
8881         nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
8882                 &nodes[1].get_block_header(conf_height), &[(0, &node_txn[0])], conf_height);
8883         if test_height_before_timelock {
8884                 // If we confirmed the close transaction, but timelocks have not yet expired, we should not
8885                 // generate any events or broadcast any transactions
8886                 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8887                 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
8888         } else {
8889                 // We should broadcast an HTLC transaction spending our funding transaction first
8890                 let spending_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
8891                 assert_eq!(spending_txn.len(), 2);
8892                 assert_eq!(spending_txn[0], node_txn[0]);
8893                 check_spends!(spending_txn[1], node_txn[0]);
8894                 // We should also generate a SpendableOutputs event with the to_self output (as its
8895                 // timelock is up).
8896                 let descriptor_spend_txn = check_spendable_outputs!(nodes[1], node_cfgs[1].keys_manager);
8897                 assert_eq!(descriptor_spend_txn.len(), 1);
8898
8899                 // If we also discover that the HTLC-Timeout transaction was confirmed some time ago, we
8900                 // should immediately fail-backwards the HTLC to the previous hop, without waiting for an
8901                 // additional block built on top of the current chain.
8902                 nodes[1].chain_monitor.chain_monitor.transactions_confirmed(
8903                         &nodes[1].get_block_header(conf_height + 1), &[(0, &spending_txn[1])], conf_height + 1);
8904                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: channel_id }]);
8905                 check_added_monitors!(nodes[1], 1);
8906
8907                 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8908                 assert!(updates.update_add_htlcs.is_empty());
8909                 assert!(updates.update_fulfill_htlcs.is_empty());
8910                 assert_eq!(updates.update_fail_htlcs.len(), 1);
8911                 assert!(updates.update_fail_malformed_htlcs.is_empty());
8912                 assert!(updates.update_fee.is_none());
8913                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
8914                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
8915                 expect_payment_failed_with_update!(nodes[0], payment_hash, false, chan_announce.contents.short_channel_id, true);
8916         }
8917 }
8918
8919 #[test]
8920 fn test_tx_confirmed_skipping_blocks_immediate_broadcast() {
8921         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(false);
8922         do_test_tx_confirmed_skipping_blocks_immediate_broadcast(true);
8923 }
8924
8925 fn do_test_dup_htlc_second_rejected(test_for_second_fail_panic: bool) {
8926         let chanmon_cfgs = create_chanmon_cfgs(2);
8927         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8928         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8929         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8930
8931         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
8932
8933         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id())
8934                 .with_features(channelmanager::provided_invoice_features());
8935         let route = get_route!(nodes[0], payment_params, 10_000, TEST_FINAL_CLTV).unwrap();
8936
8937         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(&nodes[1]);
8938
8939         {
8940                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_hash.0)).unwrap();
8941                 check_added_monitors!(nodes[0], 1);
8942                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8943                 assert_eq!(events.len(), 1);
8944                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8945                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8946                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8947         }
8948         expect_pending_htlcs_forwardable!(nodes[1]);
8949         expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 10_000);
8950
8951         {
8952                 // Note that we use a different PaymentId here to allow us to duplicativly pay
8953                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), PaymentId(our_payment_secret.0)).unwrap();
8954                 check_added_monitors!(nodes[0], 1);
8955                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8956                 assert_eq!(events.len(), 1);
8957                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8958                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8959                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8960                 // At this point, nodes[1] would notice it has too much value for the payment. It will
8961                 // assume the second is a privacy attack (no longer particularly relevant
8962                 // post-payment_secrets) and fail back the new HTLC. Previously, it'd also have failed back
8963                 // the first HTLC delivered above.
8964         }
8965
8966         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
8967         nodes[1].node.process_pending_htlc_forwards();
8968
8969         if test_for_second_fail_panic {
8970                 // Now we go fail back the first HTLC from the user end.
8971                 nodes[1].node.fail_htlc_backwards(&our_payment_hash);
8972
8973                 let expected_destinations = vec![
8974                         HTLCDestination::FailedPayment { payment_hash: our_payment_hash },
8975                         HTLCDestination::FailedPayment { payment_hash: our_payment_hash },
8976                 ];
8977                 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1],  expected_destinations);
8978                 nodes[1].node.process_pending_htlc_forwards();
8979
8980                 check_added_monitors!(nodes[1], 1);
8981                 let fail_updates_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8982                 assert_eq!(fail_updates_1.update_fail_htlcs.len(), 2);
8983
8984                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
8985                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[1]);
8986                 commitment_signed_dance!(nodes[0], nodes[1], fail_updates_1.commitment_signed, false);
8987
8988                 let failure_events = nodes[0].node.get_and_clear_pending_events();
8989                 assert_eq!(failure_events.len(), 2);
8990                 if let Event::PaymentPathFailed { .. } = failure_events[0] {} else { panic!(); }
8991                 if let Event::PaymentPathFailed { .. } = failure_events[1] {} else { panic!(); }
8992         } else {
8993                 // Let the second HTLC fail and claim the first
8994                 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
8995                 nodes[1].node.process_pending_htlc_forwards();
8996
8997                 check_added_monitors!(nodes[1], 1);
8998                 let fail_updates_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8999                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
9000                 commitment_signed_dance!(nodes[0], nodes[1], fail_updates_1.commitment_signed, false);
9001
9002                 expect_payment_failed_conditions(&nodes[0], our_payment_hash, true, PaymentFailedConditions::new().mpp_parts_remain());
9003
9004                 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
9005         }
9006 }
9007
9008 #[test]
9009 fn test_dup_htlc_second_fail_panic() {
9010         // Previously, if we received two HTLCs back-to-back, where the second overran the expected
9011         // value for the payment, we'd fail back both HTLCs after generating a `PaymentReceived` event.
9012         // Then, if the user failed the second payment, they'd hit a "tried to fail an already failed
9013         // HTLC" debug panic. This tests for this behavior, checking that only one HTLC is auto-failed.
9014         do_test_dup_htlc_second_rejected(true);
9015 }
9016
9017 #[test]
9018 fn test_dup_htlc_second_rejected() {
9019         // Test that if we receive a second HTLC for an MPP payment that overruns the payment amount we
9020         // simply reject the second HTLC but are still able to claim the first HTLC.
9021         do_test_dup_htlc_second_rejected(false);
9022 }
9023
9024 #[test]
9025 fn test_inconsistent_mpp_params() {
9026         // Test that if we recieve two HTLCs with different payment parameters we fail back the first
9027         // such HTLC and allow the second to stay.
9028         let chanmon_cfgs = create_chanmon_cfgs(4);
9029         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
9030         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
9031         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
9032
9033         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
9034         create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
9035         create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 100_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
9036         let chan_2_3 =create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 100_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
9037
9038         let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id())
9039                 .with_features(channelmanager::provided_invoice_features());
9040         let mut route = get_route!(nodes[0], payment_params, 15_000_000, TEST_FINAL_CLTV).unwrap();
9041         assert_eq!(route.paths.len(), 2);
9042         route.paths.sort_by(|path_a, _| {
9043                 // Sort the path so that the path through nodes[1] comes first
9044                 if path_a[0].pubkey == nodes[1].node.get_our_node_id() {
9045                         core::cmp::Ordering::Less } else { core::cmp::Ordering::Greater }
9046         });
9047         let payment_params_opt = Some(payment_params);
9048
9049         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(&nodes[3]);
9050
9051         let cur_height = nodes[0].best_block_info().1;
9052         let payment_id = PaymentId([42; 32]);
9053
9054         let session_privs = {
9055                 // We create a fake route here so that we start with three pending HTLCs, which we'll
9056                 // ultimately have, just not right away.
9057                 let mut dup_route = route.clone();
9058                 dup_route.paths.push(route.paths[1].clone());
9059                 nodes[0].node.test_add_new_pending_payment(our_payment_hash, Some(our_payment_secret), payment_id, &dup_route).unwrap()
9060         };
9061         {
9062                 nodes[0].node.send_payment_along_path(&route.paths[0], &payment_params_opt, &our_payment_hash, &Some(our_payment_secret), 15_000_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
9063                 check_added_monitors!(nodes[0], 1);
9064
9065                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9066                 assert_eq!(events.len(), 1);
9067                 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 15_000_000, our_payment_hash, Some(our_payment_secret), events.pop().unwrap(), false, None);
9068         }
9069         assert!(nodes[3].node.get_and_clear_pending_events().is_empty());
9070
9071         {
9072                 nodes[0].node.send_payment_along_path(&route.paths[1], &payment_params_opt, &our_payment_hash, &Some(our_payment_secret), 14_000_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
9073                 check_added_monitors!(nodes[0], 1);
9074
9075                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9076                 assert_eq!(events.len(), 1);
9077                 let payment_event = SendEvent::from_event(events.pop().unwrap());
9078
9079                 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
9080                 commitment_signed_dance!(nodes[2], nodes[0], payment_event.commitment_msg, false);
9081
9082                 expect_pending_htlcs_forwardable!(nodes[2]);
9083                 check_added_monitors!(nodes[2], 1);
9084
9085                 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
9086                 assert_eq!(events.len(), 1);
9087                 let payment_event = SendEvent::from_event(events.pop().unwrap());
9088
9089                 nodes[3].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
9090                 check_added_monitors!(nodes[3], 0);
9091                 commitment_signed_dance!(nodes[3], nodes[2], payment_event.commitment_msg, true, true);
9092
9093                 // At this point, nodes[3] should notice the two HTLCs don't contain the same total payment
9094                 // amount. It will assume the second is a privacy attack (no longer particularly relevant
9095                 // post-payment_secrets) and fail back the new HTLC.
9096         }
9097         expect_pending_htlcs_forwardable_ignore!(nodes[3]);
9098         nodes[3].node.process_pending_htlc_forwards();
9099         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[3], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
9100         nodes[3].node.process_pending_htlc_forwards();
9101
9102         check_added_monitors!(nodes[3], 1);
9103
9104         let fail_updates_1 = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
9105         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
9106         commitment_signed_dance!(nodes[2], nodes[3], fail_updates_1.commitment_signed, false);
9107
9108         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }]);
9109         check_added_monitors!(nodes[2], 1);
9110
9111         let fail_updates_2 = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
9112         nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_updates_2.update_fail_htlcs[0]);
9113         commitment_signed_dance!(nodes[0], nodes[2], fail_updates_2.commitment_signed, false);
9114
9115         expect_payment_failed_conditions(&nodes[0], our_payment_hash, true, PaymentFailedConditions::new().mpp_parts_remain());
9116
9117         nodes[0].node.send_payment_along_path(&route.paths[1], &payment_params_opt, &our_payment_hash, &Some(our_payment_secret), 15_000_000, cur_height, payment_id, &None, session_privs[2]).unwrap();
9118         check_added_monitors!(nodes[0], 1);
9119
9120         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9121         assert_eq!(events.len(), 1);
9122         pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 15_000_000, our_payment_hash, Some(our_payment_secret), events.pop().unwrap(), true, None);
9123
9124         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, our_payment_preimage);
9125 }
9126
9127 #[test]
9128 fn test_keysend_payments_to_public_node() {
9129         let chanmon_cfgs = create_chanmon_cfgs(2);
9130         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9131         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9132         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9133
9134         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features());
9135         let network_graph = nodes[0].network_graph;
9136         let payer_pubkey = nodes[0].node.get_our_node_id();
9137         let payee_pubkey = nodes[1].node.get_our_node_id();
9138         let route_params = RouteParameters {
9139                 payment_params: PaymentParameters::for_keysend(payee_pubkey),
9140                 final_value_msat: 10000,
9141                 final_cltv_expiry_delta: 40,
9142         };
9143         let scorer = test_utils::TestScorer::with_penalty(0);
9144         let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9145         let route = find_route(&payer_pubkey, &route_params, &network_graph, None, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
9146
9147         let test_preimage = PaymentPreimage([42; 32]);
9148         let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage), PaymentId(test_preimage.0)).unwrap();
9149         check_added_monitors!(nodes[0], 1);
9150         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9151         assert_eq!(events.len(), 1);
9152         let event = events.pop().unwrap();
9153         let path = vec![&nodes[1]];
9154         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9155         claim_payment(&nodes[0], &path, test_preimage);
9156 }
9157
9158 #[test]
9159 fn test_keysend_payments_to_private_node() {
9160         let chanmon_cfgs = create_chanmon_cfgs(2);
9161         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9162         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9163         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9164
9165         let payer_pubkey = nodes[0].node.get_our_node_id();
9166         let payee_pubkey = nodes[1].node.get_our_node_id();
9167         nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
9168         nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
9169
9170         let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features());
9171         let route_params = RouteParameters {
9172                 payment_params: PaymentParameters::for_keysend(payee_pubkey),
9173                 final_value_msat: 10000,
9174                 final_cltv_expiry_delta: 40,
9175         };
9176         let network_graph = nodes[0].network_graph;
9177         let first_hops = nodes[0].node.list_usable_channels();
9178         let scorer = test_utils::TestScorer::with_penalty(0);
9179         let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
9180         let route = find_route(
9181                 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
9182                 nodes[0].logger, &scorer, &random_seed_bytes
9183         ).unwrap();
9184
9185         let test_preimage = PaymentPreimage([42; 32]);
9186         let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage), PaymentId(test_preimage.0)).unwrap();
9187         check_added_monitors!(nodes[0], 1);
9188         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9189         assert_eq!(events.len(), 1);
9190         let event = events.pop().unwrap();
9191         let path = vec![&nodes[1]];
9192         pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
9193         claim_payment(&nodes[0], &path, test_preimage);
9194 }
9195
9196 #[test]
9197 fn test_double_partial_claim() {
9198         // Test what happens if a node receives a payment, generates a PaymentReceived event, the HTLCs
9199         // time out, the sender resends only some of the MPP parts, then the user processes the
9200         // PaymentReceived event, ensuring they don't inadvertently claim only part of the full payment
9201         // amount.
9202         let chanmon_cfgs = create_chanmon_cfgs(4);
9203         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
9204         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
9205         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
9206
9207         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
9208         create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
9209         create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 100_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
9210         create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 100_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
9211
9212         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 15_000_000);
9213         assert_eq!(route.paths.len(), 2);
9214         route.paths.sort_by(|path_a, _| {
9215                 // Sort the path so that the path through nodes[1] comes first
9216                 if path_a[0].pubkey == nodes[1].node.get_our_node_id() {
9217                         core::cmp::Ordering::Less } else { core::cmp::Ordering::Greater }
9218         });
9219
9220         send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 15_000_000, payment_hash, payment_secret);
9221         // nodes[3] has now received a PaymentReceived event...which it will take some (exorbitant)
9222         // amount of time to respond to.
9223
9224         // Connect some blocks to time out the payment
9225         connect_blocks(&nodes[3], TEST_FINAL_CLTV);
9226         connect_blocks(&nodes[0], TEST_FINAL_CLTV); // To get the same height for sending later
9227
9228         let failed_destinations = vec![
9229                 HTLCDestination::FailedPayment { payment_hash },
9230                 HTLCDestination::FailedPayment { payment_hash },
9231         ];
9232         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations);
9233
9234         pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
9235
9236         // nodes[1] now retries one of the two paths...
9237         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
9238         check_added_monitors!(nodes[0], 2);
9239
9240         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
9241         assert_eq!(events.len(), 2);
9242         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 15_000_000, payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
9243
9244         // At this point nodes[3] has received one half of the payment, and the user goes to handle
9245         // that PaymentReceived event they got hours ago and never handled...we should refuse to claim.
9246         nodes[3].node.claim_funds(payment_preimage);
9247         check_added_monitors!(nodes[3], 0);
9248         assert!(nodes[3].node.get_and_clear_pending_msg_events().is_empty());
9249 }
9250
9251 /// The possible events which may trigger a `max_dust_htlc_exposure` breach
9252 #[derive(Clone, Copy, PartialEq)]
9253 enum ExposureEvent {
9254         /// Breach occurs at HTLC forwarding (see `send_htlc`)
9255         AtHTLCForward,
9256         /// Breach occurs at HTLC reception (see `update_add_htlc`)
9257         AtHTLCReception,
9258         /// Breach occurs at outbound update_fee (see `send_update_fee`)
9259         AtUpdateFeeOutbound,
9260 }
9261
9262 fn do_test_max_dust_htlc_exposure(dust_outbound_balance: bool, exposure_breach_event: ExposureEvent, on_holder_tx: bool) {
9263         // Test that we properly reject dust HTLC violating our `max_dust_htlc_exposure_msat`
9264         // policy.
9265         //
9266         // At HTLC forward (`send_payment()`), if the sum of the trimmed-to-dust HTLC inbound and
9267         // trimmed-to-dust HTLC outbound balance and this new payment as included on next
9268         // counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll reject the
9269         // update. At HTLC reception (`update_add_htlc()`), if the sum of the trimmed-to-dust HTLC
9270         // inbound and trimmed-to-dust HTLC outbound balance and this new received HTLC as included
9271         // on next counterparty commitment are above our `max_dust_htlc_exposure_msat`, we'll fail
9272         // the update. Note, we return a `temporary_channel_failure` (0x1000 | 7), as the channel
9273         // might be available again for HTLC processing once the dust bandwidth has cleared up.
9274
9275         let chanmon_cfgs = create_chanmon_cfgs(2);
9276         let mut config = test_default_channel_config();
9277         config.channel_config.max_dust_htlc_exposure_msat = 5_000_000; // default setting value
9278         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9279         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), None]);
9280         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9281
9282         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
9283         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9284         open_channel.max_htlc_value_in_flight_msat = 50_000_000;
9285         open_channel.max_accepted_htlcs = 60;
9286         if on_holder_tx {
9287                 open_channel.dust_limit_satoshis = 546;
9288         }
9289         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
9290         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9291         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
9292
9293         let opt_anchors = false;
9294
9295         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
9296
9297         if on_holder_tx {
9298                 if let Some(mut chan) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&temporary_channel_id) {
9299                         chan.holder_dust_limit_satoshis = 546;
9300                 }
9301         }
9302
9303         nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
9304         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()));
9305         check_added_monitors!(nodes[1], 1);
9306
9307         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()));
9308         check_added_monitors!(nodes[0], 1);
9309
9310         let (channel_ready, channel_id) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
9311         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
9312         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
9313
9314         let dust_buffer_feerate = {
9315                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
9316                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
9317                 chan.get_dust_buffer_feerate(None) as u64
9318         };
9319         let dust_outbound_htlc_on_holder_tx_msat: u64 = (dust_buffer_feerate * htlc_timeout_tx_weight(opt_anchors) / 1000 + open_channel.dust_limit_satoshis - 1) * 1000;
9320         let dust_outbound_htlc_on_holder_tx: u64 = config.channel_config.max_dust_htlc_exposure_msat / dust_outbound_htlc_on_holder_tx_msat;
9321
9322         let dust_inbound_htlc_on_holder_tx_msat: u64 = (dust_buffer_feerate * htlc_success_tx_weight(opt_anchors) / 1000 + open_channel.dust_limit_satoshis - 1) * 1000;
9323         let dust_inbound_htlc_on_holder_tx: u64 = config.channel_config.max_dust_htlc_exposure_msat / dust_inbound_htlc_on_holder_tx_msat;
9324
9325         let dust_htlc_on_counterparty_tx: u64 = 25;
9326         let dust_htlc_on_counterparty_tx_msat: u64 = config.channel_config.max_dust_htlc_exposure_msat / dust_htlc_on_counterparty_tx;
9327
9328         if on_holder_tx {
9329                 if dust_outbound_balance {
9330                         // Outbound dust threshold: 2223 sats (`dust_buffer_feerate` * HTLC_TIMEOUT_TX_WEIGHT / 1000 + holder's `dust_limit_satoshis`)
9331                         // Outbound dust balance: 4372 sats
9332                         // Note, we need sent payment to be above outbound dust threshold on counterparty_tx of 2132 sats
9333                         for i in 0..dust_outbound_htlc_on_holder_tx {
9334                                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], dust_outbound_htlc_on_holder_tx_msat);
9335                                 if let Err(_) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)) { panic!("Unexpected event at dust HTLC {}", i); }
9336                         }
9337                 } else {
9338                         // Inbound dust threshold: 2324 sats (`dust_buffer_feerate` * HTLC_SUCCESS_TX_WEIGHT / 1000 + holder's `dust_limit_satoshis`)
9339                         // Inbound dust balance: 4372 sats
9340                         // Note, we need sent payment to be above outbound dust threshold on counterparty_tx of 2031 sats
9341                         for _ in 0..dust_inbound_htlc_on_holder_tx {
9342                                 route_payment(&nodes[1], &[&nodes[0]], dust_inbound_htlc_on_holder_tx_msat);
9343                         }
9344                 }
9345         } else {
9346                 if dust_outbound_balance {
9347                         // Outbound dust threshold: 2132 sats (`dust_buffer_feerate` * HTLC_TIMEOUT_TX_WEIGHT / 1000 + counteparty's `dust_limit_satoshis`)
9348                         // Outbound dust balance: 5000 sats
9349                         for i in 0..dust_htlc_on_counterparty_tx {
9350                                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], dust_htlc_on_counterparty_tx_msat);
9351                                 if let Err(_) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)) { panic!("Unexpected event at dust HTLC {}", i); }
9352                         }
9353                 } else {
9354                         // Inbound dust threshold: 2031 sats (`dust_buffer_feerate` * HTLC_TIMEOUT_TX_WEIGHT / 1000 + counteparty's `dust_limit_satoshis`)
9355                         // Inbound dust balance: 5000 sats
9356                         for _ in 0..dust_htlc_on_counterparty_tx {
9357                                 route_payment(&nodes[1], &[&nodes[0]], dust_htlc_on_counterparty_tx_msat);
9358                         }
9359                 }
9360         }
9361
9362         let dust_overflow = dust_htlc_on_counterparty_tx_msat * (dust_htlc_on_counterparty_tx + 1);
9363         if exposure_breach_event == ExposureEvent::AtHTLCForward {
9364                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], if on_holder_tx { dust_outbound_htlc_on_holder_tx_msat } else { dust_htlc_on_counterparty_tx_msat });
9365                 let mut config = UserConfig::default();
9366                 // With default dust exposure: 5000 sats
9367                 if on_holder_tx {
9368                         let dust_outbound_overflow = dust_outbound_htlc_on_holder_tx_msat * (dust_outbound_htlc_on_holder_tx + 1);
9369                         let dust_inbound_overflow = dust_inbound_htlc_on_holder_tx_msat * dust_inbound_htlc_on_holder_tx + dust_outbound_htlc_on_holder_tx_msat;
9370                         unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)), 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", if dust_outbound_balance { dust_outbound_overflow } else { dust_inbound_overflow }, config.channel_config.max_dust_htlc_exposure_msat)));
9371                 } else {
9372                         unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)), 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", dust_overflow, config.channel_config.max_dust_htlc_exposure_msat)));
9373                 }
9374         } else if exposure_breach_event == ExposureEvent::AtHTLCReception {
9375                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], if on_holder_tx { dust_inbound_htlc_on_holder_tx_msat } else { dust_htlc_on_counterparty_tx_msat });
9376                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
9377                 check_added_monitors!(nodes[1], 1);
9378                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
9379                 assert_eq!(events.len(), 1);
9380                 let payment_event = SendEvent::from_event(events.remove(0));
9381                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
9382                 // With default dust exposure: 5000 sats
9383                 if on_holder_tx {
9384                         // Outbound dust balance: 6399 sats
9385                         let dust_inbound_overflow = dust_inbound_htlc_on_holder_tx_msat * (dust_inbound_htlc_on_holder_tx + 1);
9386                         let dust_outbound_overflow = dust_outbound_htlc_on_holder_tx_msat * dust_outbound_htlc_on_holder_tx + dust_inbound_htlc_on_holder_tx_msat;
9387                         nodes[0].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", if dust_outbound_balance { dust_outbound_overflow } else { dust_inbound_overflow }, config.channel_config.max_dust_htlc_exposure_msat), 1);
9388                 } else {
9389                         // Outbound dust balance: 5200 sats
9390                         nodes[0].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", dust_overflow, config.channel_config.max_dust_htlc_exposure_msat), 1);
9391                 }
9392         } else if exposure_breach_event == ExposureEvent::AtUpdateFeeOutbound {
9393                 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 2_500_000);
9394                 if let Err(_) = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)) { panic!("Unexpected event at update_fee-swallowed HTLC", ); }
9395                 {
9396                         let mut feerate_lock = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
9397                         *feerate_lock = *feerate_lock * 10;
9398                 }
9399                 nodes[0].node.timer_tick_occurred();
9400                 check_added_monitors!(nodes[0], 1);
9401                 nodes[0].logger.assert_log_contains("lightning::ln::channel".to_string(), "Cannot afford to send new feerate at 2530 without infringing max dust htlc exposure".to_string(), 1);
9402         }
9403
9404         let _ = nodes[0].node.get_and_clear_pending_msg_events();
9405         let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
9406         added_monitors.clear();
9407 }
9408
9409 #[test]
9410 fn test_max_dust_htlc_exposure() {
9411         do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCForward, true);
9412         do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCForward, true);
9413         do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCReception, true);
9414         do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCReception, false);
9415         do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCForward, false);
9416         do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCReception, false);
9417         do_test_max_dust_htlc_exposure(true, ExposureEvent::AtHTLCReception, true);
9418         do_test_max_dust_htlc_exposure(false, ExposureEvent::AtHTLCForward, false);
9419         do_test_max_dust_htlc_exposure(true, ExposureEvent::AtUpdateFeeOutbound, true);
9420         do_test_max_dust_htlc_exposure(true, ExposureEvent::AtUpdateFeeOutbound, false);
9421         do_test_max_dust_htlc_exposure(false, ExposureEvent::AtUpdateFeeOutbound, false);
9422         do_test_max_dust_htlc_exposure(false, ExposureEvent::AtUpdateFeeOutbound, true);
9423 }
9424
9425 #[test]
9426 fn test_non_final_funding_tx() {
9427         let chanmon_cfgs = create_chanmon_cfgs(2);
9428         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
9429         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
9430         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
9431
9432         let temp_channel_id = nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 42, None).unwrap();
9433         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
9434         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel_message);
9435         let accept_channel_message = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
9436         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel_message);
9437
9438         let best_height = nodes[0].node.best_block.read().unwrap().height();
9439
9440         let chan_id = *nodes[0].network_chan_count.borrow();
9441         let events = nodes[0].node.get_and_clear_pending_events();
9442         let input = TxIn { previous_output: BitcoinOutPoint::null(), script_sig: bitcoin::Script::new(), sequence: Sequence(1), witness: Witness::from_vec(vec!(vec!(1))) };
9443         assert_eq!(events.len(), 1);
9444         let mut tx = match events[0] {
9445                 Event::FundingGenerationReady { ref channel_value_satoshis, ref output_script, .. } => {
9446                         // Timelock the transaction _beyond_ the best client height + 2.
9447                         Transaction { version: chan_id as i32, lock_time: PackedLockTime(best_height + 3), input: vec![input], output: vec![TxOut {
9448                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
9449                         }]}
9450                 },
9451                 _ => panic!("Unexpected event"),
9452         };
9453         // Transaction should fail as it's evaluated as non-final for propagation.
9454         match nodes[0].node.funding_transaction_generated(&temp_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()) {
9455                 Err(APIError::APIMisuseError { err }) => {
9456                         assert_eq!(format!("Funding transaction absolute timelock is non-final"), err);
9457                 },
9458                 _ => panic!()
9459         }
9460
9461         // However, transaction should be accepted if it's in a +2 headroom from best block.
9462         tx.lock_time = PackedLockTime(tx.lock_time.0 - 1);
9463         assert!(nodes[0].node.funding_transaction_generated(&temp_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).is_ok());
9464         get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
9465 }