Move HTLC tx generation in OnchainTxHandler
[rust-lightning] / lightning / src / ln / functional_tests.rs
1 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
2 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
3 //! claim outputs on-chain.
4
5 use chain::transaction::OutPoint;
6 use chain::keysinterface::{ChannelKeys, KeysInterface, SpendableOutputDescriptor};
7 use chain::chaininterface::{ChainListener, ChainWatchInterfaceUtil, BlockNotifier};
8 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
9 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
10 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
11 use ln::channel::{Channel, ChannelError};
12 use ln::{chan_utils, onion_utils};
13 use ln::router::{Route, RouteHop};
14 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
15 use ln::msgs;
16 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
17 use util::enforcing_trait_impls::EnforcingChannelKeys;
18 use util::test_utils;
19 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
20 use util::errors::APIError;
21 use util::ser::{Writeable, Writer, ReadableArgs};
22 use util::config::UserConfig;
23 use util::logger::Logger;
24
25 use bitcoin::util::hash::BitcoinHash;
26 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
27 use bitcoin::util::bip143;
28 use bitcoin::util::address::Address;
29 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
30 use bitcoin::blockdata::block::{Block, BlockHeader};
31 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
32 use bitcoin::blockdata::script::{Builder, Script};
33 use bitcoin::blockdata::opcodes;
34 use bitcoin::blockdata::constants::genesis_block;
35 use bitcoin::network::constants::Network;
36
37 use bitcoin_hashes::sha256::Hash as Sha256;
38 use bitcoin_hashes::Hash;
39
40 use secp256k1::{Secp256k1, Message};
41 use secp256k1::key::{PublicKey,SecretKey};
42
43 use std::collections::{BTreeSet, HashMap, HashSet};
44 use std::default::Default;
45 use std::sync::{Arc, Mutex};
46 use std::sync::atomic::Ordering;
47 use std::{mem, io};
48
49 use rand::{thread_rng, Rng};
50
51 use ln::functional_test_utils::*;
52
53 #[test]
54 fn test_insane_channel_opens() {
55         // Stand up a network of 2 nodes
56         let chanmon_cfgs = create_chanmon_cfgs(2);
57         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
58         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
59         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
60
61         // Instantiate channel parameters where we push the maximum msats given our
62         // funding satoshis
63         let channel_value_sat = 31337; // same as funding satoshis
64         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_our_channel_reserve_satoshis(channel_value_sat);
65         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
66
67         // Have node0 initiate a channel to node1 with aforementioned parameters
68         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
69
70         // Extract the channel open message from node0 to node1
71         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
72
73         // Test helper that asserts we get the correct error string given a mutator
74         // that supposedly makes the channel open message insane
75         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
76                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &message_mutator(open_channel_message.clone()));
77                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
78                 assert_eq!(msg_events.len(), 1);
79                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
80                         match action {
81                                 &ErrorAction::SendErrorMessage { .. } => {
82                                         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), expected_error_str.to_string(), 1);
83                                 },
84                                 _ => panic!("unexpected event!"),
85                         }
86                 } else { assert!(false); }
87         };
88
89         use ln::channel::MAX_FUNDING_SATOSHIS;
90         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
91
92         // Test all mutations that would make the channel open message insane
93         insane_open_helper("funding value > 2^24", |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
94
95         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
96
97         insane_open_helper("push_msat larger than funding value", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
98
99         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
100
101         insane_open_helper("Bogus; channel reserve is less than dust limit", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
102
103         insane_open_helper("Minimum htlc value is full channel value", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
104
105         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 });
106
107         insane_open_helper("0 max_accpted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
108
109         insane_open_helper("max_accpted_htlcs > 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
110 }
111
112 #[test]
113 fn test_async_inbound_update_fee() {
114         let chanmon_cfgs = create_chanmon_cfgs(2);
115         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
116         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
117         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
118         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
119         let channel_id = chan.2;
120
121         // balancing
122         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
123
124         // A                                        B
125         // update_fee                            ->
126         // send (1) commitment_signed            -.
127         //                                       <- update_add_htlc/commitment_signed
128         // send (2) RAA (awaiting remote revoke) -.
129         // (1) commitment_signed is delivered    ->
130         //                                       .- send (3) RAA (awaiting remote revoke)
131         // (2) RAA is delivered                  ->
132         //                                       .- send (4) commitment_signed
133         //                                       <- (3) RAA is delivered
134         // send (5) commitment_signed            -.
135         //                                       <- (4) commitment_signed is delivered
136         // send (6) RAA                          -.
137         // (5) commitment_signed is delivered    ->
138         //                                       <- RAA
139         // (6) RAA is delivered                  ->
140
141         // First nodes[0] generates an update_fee
142         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
143         check_added_monitors!(nodes[0], 1);
144
145         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
146         assert_eq!(events_0.len(), 1);
147         let (update_msg, commitment_signed) = match events_0[0] { // (1)
148                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
149                         (update_fee.as_ref(), commitment_signed)
150                 },
151                 _ => panic!("Unexpected event"),
152         };
153
154         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
155
156         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
157         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
158         nodes[1].node.send_payment(&nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash, &None).unwrap();
159         check_added_monitors!(nodes[1], 1);
160
161         let payment_event = {
162                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
163                 assert_eq!(events_1.len(), 1);
164                 SendEvent::from_event(events_1.remove(0))
165         };
166         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
167         assert_eq!(payment_event.msgs.len(), 1);
168
169         // ...now when the messages get delivered everyone should be happy
170         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
171         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
172         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
173         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
174         check_added_monitors!(nodes[0], 1);
175
176         // deliver(1), generate (3):
177         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
178         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
179         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
180         check_added_monitors!(nodes[1], 1);
181
182         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
183         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
184         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
185         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
186         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
187         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
188         assert!(bs_update.update_fee.is_none()); // (4)
189         check_added_monitors!(nodes[1], 1);
190
191         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
192         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
193         assert!(as_update.update_add_htlcs.is_empty()); // (5)
194         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
195         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
196         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
197         assert!(as_update.update_fee.is_none()); // (5)
198         check_added_monitors!(nodes[0], 1);
199
200         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
201         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
202         // only (6) so get_event_msg's assert(len == 1) passes
203         check_added_monitors!(nodes[0], 1);
204
205         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
206         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
207         check_added_monitors!(nodes[1], 1);
208
209         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
210         check_added_monitors!(nodes[0], 1);
211
212         let events_2 = nodes[0].node.get_and_clear_pending_events();
213         assert_eq!(events_2.len(), 1);
214         match events_2[0] {
215                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
216                 _ => panic!("Unexpected event"),
217         }
218
219         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
220         check_added_monitors!(nodes[1], 1);
221 }
222
223 #[test]
224 fn test_update_fee_unordered_raa() {
225         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
226         // crash in an earlier version of the update_fee patch)
227         let chanmon_cfgs = create_chanmon_cfgs(2);
228         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
229         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
230         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
231         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
232         let channel_id = chan.2;
233
234         // balancing
235         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
236
237         // First nodes[0] generates an update_fee
238         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
239         check_added_monitors!(nodes[0], 1);
240
241         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
242         assert_eq!(events_0.len(), 1);
243         let update_msg = match events_0[0] { // (1)
244                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
245                         update_fee.as_ref()
246                 },
247                 _ => panic!("Unexpected event"),
248         };
249
250         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
251
252         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
253         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
254         nodes[1].node.send_payment(&nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash, &None).unwrap();
255         check_added_monitors!(nodes[1], 1);
256
257         let payment_event = {
258                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
259                 assert_eq!(events_1.len(), 1);
260                 SendEvent::from_event(events_1.remove(0))
261         };
262         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
263         assert_eq!(payment_event.msgs.len(), 1);
264
265         // ...now when the messages get delivered everyone should be happy
266         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
267         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
268         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
269         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
270         check_added_monitors!(nodes[0], 1);
271
272         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
273         check_added_monitors!(nodes[1], 1);
274
275         // We can't continue, sadly, because our (1) now has a bogus signature
276 }
277
278 #[test]
279 fn test_multi_flight_update_fee() {
280         let chanmon_cfgs = create_chanmon_cfgs(2);
281         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
282         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
283         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
284         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
285         let channel_id = chan.2;
286
287         // A                                        B
288         // update_fee/commitment_signed          ->
289         //                                       .- send (1) RAA and (2) commitment_signed
290         // update_fee (never committed)          ->
291         // (3) update_fee                        ->
292         // We have to manually generate the above update_fee, it is allowed by the protocol but we
293         // don't track which updates correspond to which revoke_and_ack responses so we're in
294         // AwaitingRAA mode and will not generate the update_fee yet.
295         //                                       <- (1) RAA delivered
296         // (3) is generated and send (4) CS      -.
297         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
298         // know the per_commitment_point to use for it.
299         //                                       <- (2) commitment_signed delivered
300         // revoke_and_ack                        ->
301         //                                          B should send no response here
302         // (4) commitment_signed delivered       ->
303         //                                       <- RAA/commitment_signed delivered
304         // revoke_and_ack                        ->
305
306         // First nodes[0] generates an update_fee
307         let initial_feerate = get_feerate!(nodes[0], channel_id);
308         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
309         check_added_monitors!(nodes[0], 1);
310
311         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
312         assert_eq!(events_0.len(), 1);
313         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
314                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
315                         (update_fee.as_ref().unwrap(), commitment_signed)
316                 },
317                 _ => panic!("Unexpected event"),
318         };
319
320         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
321         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
322         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
323         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
324         check_added_monitors!(nodes[1], 1);
325
326         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
327         // transaction:
328         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
329         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
330         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
331
332         // Create the (3) update_fee message that nodes[0] will generate before it does...
333         let mut update_msg_2 = msgs::UpdateFee {
334                 channel_id: update_msg_1.channel_id.clone(),
335                 feerate_per_kw: (initial_feerate + 30) as u32,
336         };
337
338         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
339
340         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
341         // Deliver (3)
342         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
343
344         // Deliver (1), generating (3) and (4)
345         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
346         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
347         check_added_monitors!(nodes[0], 1);
348         assert!(as_second_update.update_add_htlcs.is_empty());
349         assert!(as_second_update.update_fulfill_htlcs.is_empty());
350         assert!(as_second_update.update_fail_htlcs.is_empty());
351         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
352         // Check that the update_fee newly generated matches what we delivered:
353         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
354         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
355
356         // Deliver (2) commitment_signed
357         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
358         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
359         check_added_monitors!(nodes[0], 1);
360         // No commitment_signed so get_event_msg's assert(len == 1) passes
361
362         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
363         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
364         check_added_monitors!(nodes[1], 1);
365
366         // Delever (4)
367         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
368         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
369         check_added_monitors!(nodes[1], 1);
370
371         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
372         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
373         check_added_monitors!(nodes[0], 1);
374
375         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
376         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
377         // No commitment_signed so get_event_msg's assert(len == 1) passes
378         check_added_monitors!(nodes[0], 1);
379
380         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
381         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
382         check_added_monitors!(nodes[1], 1);
383 }
384
385 #[test]
386 fn test_1_conf_open() {
387         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
388         // tests that we properly send one in that case.
389         let mut alice_config = UserConfig::default();
390         alice_config.own_channel_config.minimum_depth = 1;
391         alice_config.channel_options.announced_channel = true;
392         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
393         let mut bob_config = UserConfig::default();
394         bob_config.own_channel_config.minimum_depth = 1;
395         bob_config.channel_options.announced_channel = true;
396         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
397         let chanmon_cfgs = create_chanmon_cfgs(2);
398         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
399         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
400         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
401
402         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
403         assert!(nodes[0].chain_monitor.does_match_tx(&tx));
404         assert!(nodes[1].chain_monitor.does_match_tx(&tx));
405
406         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
407         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
408         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
409
410         nodes[0].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
411         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
412         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
413
414         for node in nodes {
415                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
416                 node.router.handle_channel_update(&as_update).unwrap();
417                 node.router.handle_channel_update(&bs_update).unwrap();
418         }
419 }
420
421 fn do_test_sanity_on_in_flight_opens(steps: u8) {
422         // Previously, we had issues deserializing channels when we hadn't connected the first block
423         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
424         // serialization round-trips and simply do steps towards opening a channel and then drop the
425         // Node objects.
426
427         let chanmon_cfgs = create_chanmon_cfgs(2);
428         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
429         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
430         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
431
432         if steps & 0b1000_0000 != 0{
433                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
434                 nodes[0].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
435                 nodes[1].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
436         }
437
438         if steps & 0x0f == 0 { return; }
439         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
440         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
441
442         if steps & 0x0f == 1 { return; }
443         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &open_channel);
444         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
445
446         if steps & 0x0f == 2 { return; }
447         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
448
449         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
450
451         if steps & 0x0f == 3 { return; }
452         {
453                 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
454                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
455                 assert_eq!(added_monitors.len(), 1);
456                 assert_eq!(added_monitors[0].0, funding_output);
457                 added_monitors.clear();
458         }
459         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
460
461         if steps & 0x0f == 4 { return; }
462         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
463         {
464                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
465                 assert_eq!(added_monitors.len(), 1);
466                 assert_eq!(added_monitors[0].0, funding_output);
467                 added_monitors.clear();
468         }
469         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
470
471         if steps & 0x0f == 5 { return; }
472         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
473         {
474                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
475                 assert_eq!(added_monitors.len(), 1);
476                 assert_eq!(added_monitors[0].0, funding_output);
477                 added_monitors.clear();
478         }
479
480         let events_4 = nodes[0].node.get_and_clear_pending_events();
481         assert_eq!(events_4.len(), 1);
482         match events_4[0] {
483                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
484                         assert_eq!(user_channel_id, 42);
485                         assert_eq!(*funding_txo, funding_output);
486                 },
487                 _ => panic!("Unexpected event"),
488         };
489
490         if steps & 0x0f == 6 { return; }
491         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
492
493         if steps & 0x0f == 7 { return; }
494         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
495         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
496 }
497
498 #[test]
499 fn test_sanity_on_in_flight_opens() {
500         do_test_sanity_on_in_flight_opens(0);
501         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
502         do_test_sanity_on_in_flight_opens(1);
503         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
504         do_test_sanity_on_in_flight_opens(2);
505         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
506         do_test_sanity_on_in_flight_opens(3);
507         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
508         do_test_sanity_on_in_flight_opens(4);
509         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
510         do_test_sanity_on_in_flight_opens(5);
511         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
512         do_test_sanity_on_in_flight_opens(6);
513         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
514         do_test_sanity_on_in_flight_opens(7);
515         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
516         do_test_sanity_on_in_flight_opens(8);
517         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
518 }
519
520 #[test]
521 fn test_update_fee_vanilla() {
522         let chanmon_cfgs = create_chanmon_cfgs(2);
523         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
524         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
525         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
526         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
527         let channel_id = chan.2;
528
529         let feerate = get_feerate!(nodes[0], channel_id);
530         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
531         check_added_monitors!(nodes[0], 1);
532
533         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
534         assert_eq!(events_0.len(), 1);
535         let (update_msg, commitment_signed) = match events_0[0] {
536                         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 } } => {
537                         (update_fee.as_ref(), commitment_signed)
538                 },
539                 _ => panic!("Unexpected event"),
540         };
541         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
542
543         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
544         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
545         check_added_monitors!(nodes[1], 1);
546
547         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
548         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
549         check_added_monitors!(nodes[0], 1);
550
551         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
552         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
553         // No commitment_signed so get_event_msg's assert(len == 1) passes
554         check_added_monitors!(nodes[0], 1);
555
556         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
557         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
558         check_added_monitors!(nodes[1], 1);
559 }
560
561 #[test]
562 fn test_update_fee_that_funder_cannot_afford() {
563         let chanmon_cfgs = create_chanmon_cfgs(2);
564         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
565         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
566         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
567         let channel_value = 1888;
568         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::supported(), InitFeatures::supported());
569         let channel_id = chan.2;
570
571         let feerate = 260;
572         nodes[0].node.update_fee(channel_id, feerate).unwrap();
573         check_added_monitors!(nodes[0], 1);
574         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
575
576         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
577
578         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
579
580         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
581         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
582         {
583                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
584
585                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
586                 let num_htlcs = commitment_tx.output.len() - 2;
587                 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
588                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
589                 actual_fee = channel_value - actual_fee;
590                 assert_eq!(total_fee, actual_fee);
591         }
592
593         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
594         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
595         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
596         check_added_monitors!(nodes[0], 1);
597
598         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
599
600         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
601
602         //While producing the commitment_signed response after handling a received update_fee request the
603         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
604         //Should produce and error.
605         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
606         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
607         check_added_monitors!(nodes[1], 1);
608         check_closed_broadcast!(nodes[1], true);
609 }
610
611 #[test]
612 fn test_update_fee_with_fundee_update_add_htlc() {
613         let chanmon_cfgs = create_chanmon_cfgs(2);
614         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
615         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
616         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
617         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
618         let channel_id = chan.2;
619
620         // balancing
621         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
622
623         let feerate = get_feerate!(nodes[0], channel_id);
624         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
625         check_added_monitors!(nodes[0], 1);
626
627         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
628         assert_eq!(events_0.len(), 1);
629         let (update_msg, commitment_signed) = match events_0[0] {
630                         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 } } => {
631                         (update_fee.as_ref(), commitment_signed)
632                 },
633                 _ => panic!("Unexpected event"),
634         };
635         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
636         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
637         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
638         check_added_monitors!(nodes[1], 1);
639
640         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
641
642         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
643
644         // nothing happens since node[1] is in AwaitingRemoteRevoke
645         nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
646         {
647                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
648                 assert_eq!(added_monitors.len(), 0);
649                 added_monitors.clear();
650         }
651         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
652         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
653         // node[1] has nothing to do
654
655         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
656         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
657         check_added_monitors!(nodes[0], 1);
658
659         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
660         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
661         // No commitment_signed so get_event_msg's assert(len == 1) passes
662         check_added_monitors!(nodes[0], 1);
663         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
664         check_added_monitors!(nodes[1], 1);
665         // AwaitingRemoteRevoke ends here
666
667         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
668         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
669         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
670         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
671         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
672         assert_eq!(commitment_update.update_fee.is_none(), true);
673
674         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
675         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
676         check_added_monitors!(nodes[0], 1);
677         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
678
679         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
680         check_added_monitors!(nodes[1], 1);
681         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
682
683         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
684         check_added_monitors!(nodes[1], 1);
685         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
686         // No commitment_signed so get_event_msg's assert(len == 1) passes
687
688         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
689         check_added_monitors!(nodes[0], 1);
690         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
691
692         expect_pending_htlcs_forwardable!(nodes[0]);
693
694         let events = nodes[0].node.get_and_clear_pending_events();
695         assert_eq!(events.len(), 1);
696         match events[0] {
697                 Event::PaymentReceived { .. } => { },
698                 _ => panic!("Unexpected event"),
699         };
700
701         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
702
703         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
704         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
705         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
706 }
707
708 #[test]
709 fn test_update_fee() {
710         let chanmon_cfgs = create_chanmon_cfgs(2);
711         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
712         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
713         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
714         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
715         let channel_id = chan.2;
716
717         // A                                        B
718         // (1) update_fee/commitment_signed      ->
719         //                                       <- (2) revoke_and_ack
720         //                                       .- send (3) commitment_signed
721         // (4) update_fee/commitment_signed      ->
722         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
723         //                                       <- (3) commitment_signed delivered
724         // send (6) revoke_and_ack               -.
725         //                                       <- (5) deliver revoke_and_ack
726         // (6) deliver revoke_and_ack            ->
727         //                                       .- send (7) commitment_signed in response to (4)
728         //                                       <- (7) deliver commitment_signed
729         // revoke_and_ack                        ->
730
731         // Create and deliver (1)...
732         let feerate = get_feerate!(nodes[0], channel_id);
733         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
734         check_added_monitors!(nodes[0], 1);
735
736         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
737         assert_eq!(events_0.len(), 1);
738         let (update_msg, commitment_signed) = match events_0[0] {
739                         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 } } => {
740                         (update_fee.as_ref(), commitment_signed)
741                 },
742                 _ => panic!("Unexpected event"),
743         };
744         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
745
746         // Generate (2) and (3):
747         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
748         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
749         check_added_monitors!(nodes[1], 1);
750
751         // Deliver (2):
752         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
753         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
754         check_added_monitors!(nodes[0], 1);
755
756         // Create and deliver (4)...
757         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
758         check_added_monitors!(nodes[0], 1);
759         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
760         assert_eq!(events_0.len(), 1);
761         let (update_msg, commitment_signed) = match events_0[0] {
762                         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 } } => {
763                         (update_fee.as_ref(), commitment_signed)
764                 },
765                 _ => panic!("Unexpected event"),
766         };
767
768         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
769         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
770         check_added_monitors!(nodes[1], 1);
771         // ... creating (5)
772         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
773         // No commitment_signed so get_event_msg's assert(len == 1) passes
774
775         // Handle (3), creating (6):
776         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
777         check_added_monitors!(nodes[0], 1);
778         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
779         // No commitment_signed so get_event_msg's assert(len == 1) passes
780
781         // Deliver (5):
782         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
783         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
784         check_added_monitors!(nodes[0], 1);
785
786         // Deliver (6), creating (7):
787         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
788         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
789         assert!(commitment_update.update_add_htlcs.is_empty());
790         assert!(commitment_update.update_fulfill_htlcs.is_empty());
791         assert!(commitment_update.update_fail_htlcs.is_empty());
792         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
793         assert!(commitment_update.update_fee.is_none());
794         check_added_monitors!(nodes[1], 1);
795
796         // Deliver (7)
797         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
798         check_added_monitors!(nodes[0], 1);
799         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
800         // No commitment_signed so get_event_msg's assert(len == 1) passes
801
802         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
803         check_added_monitors!(nodes[1], 1);
804         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
805
806         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
807         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
808         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
809 }
810
811 #[test]
812 fn pre_funding_lock_shutdown_test() {
813         // Test sending a shutdown prior to funding_locked after funding generation
814         let chanmon_cfgs = create_chanmon_cfgs(2);
815         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
816         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
817         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
818         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::supported(), InitFeatures::supported());
819         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
820         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
821         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
822
823         nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
824         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
825         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
826         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
827         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
828
829         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
830         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
831         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
832         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
833         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
834         assert!(node_0_none.is_none());
835
836         assert!(nodes[0].node.list_channels().is_empty());
837         assert!(nodes[1].node.list_channels().is_empty());
838 }
839
840 #[test]
841 fn updates_shutdown_wait() {
842         // Test sending a shutdown with outstanding updates pending
843         let chanmon_cfgs = create_chanmon_cfgs(3);
844         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
845         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
846         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
847         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
848         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
849         let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
850         let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
851
852         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
853
854         nodes[0].node.close_channel(&chan_1.2).unwrap();
855         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
856         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
857         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
858         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
859
860         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
861         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
862
863         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
864         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
865         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
866
867         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
868         check_added_monitors!(nodes[2], 1);
869         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
870         assert!(updates.update_add_htlcs.is_empty());
871         assert!(updates.update_fail_htlcs.is_empty());
872         assert!(updates.update_fail_malformed_htlcs.is_empty());
873         assert!(updates.update_fee.is_none());
874         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
875         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
876         check_added_monitors!(nodes[1], 1);
877         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
878         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
879
880         assert!(updates_2.update_add_htlcs.is_empty());
881         assert!(updates_2.update_fail_htlcs.is_empty());
882         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
883         assert!(updates_2.update_fee.is_none());
884         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
885         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
886         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
887
888         let events = nodes[0].node.get_and_clear_pending_events();
889         assert_eq!(events.len(), 1);
890         match events[0] {
891                 Event::PaymentSent { ref payment_preimage } => {
892                         assert_eq!(our_payment_preimage, *payment_preimage);
893                 },
894                 _ => panic!("Unexpected event"),
895         }
896
897         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
898         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
899         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
900         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
901         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
902         assert!(node_0_none.is_none());
903
904         assert!(nodes[0].node.list_channels().is_empty());
905
906         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
907         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
908         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
909         assert!(nodes[1].node.list_channels().is_empty());
910         assert!(nodes[2].node.list_channels().is_empty());
911 }
912
913 #[test]
914 fn htlc_fail_async_shutdown() {
915         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
916         let chanmon_cfgs = create_chanmon_cfgs(3);
917         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
918         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
919         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
920         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
921         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
922
923         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
924         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
925         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
926         check_added_monitors!(nodes[0], 1);
927         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
928         assert_eq!(updates.update_add_htlcs.len(), 1);
929         assert!(updates.update_fulfill_htlcs.is_empty());
930         assert!(updates.update_fail_htlcs.is_empty());
931         assert!(updates.update_fail_malformed_htlcs.is_empty());
932         assert!(updates.update_fee.is_none());
933
934         nodes[1].node.close_channel(&chan_1.2).unwrap();
935         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
936         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
937         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
938
939         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
940         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
941         check_added_monitors!(nodes[1], 1);
942         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
943         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
944
945         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
946         assert!(updates_2.update_add_htlcs.is_empty());
947         assert!(updates_2.update_fulfill_htlcs.is_empty());
948         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
949         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
950         assert!(updates_2.update_fee.is_none());
951
952         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
953         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
954
955         let events = nodes[0].node.get_and_clear_pending_events();
956         assert_eq!(events.len(), 1);
957         match events[0] {
958                 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
959                         assert_eq!(our_payment_hash, *payment_hash);
960                         assert!(!rejected_by_dest);
961                 },
962                 _ => panic!("Unexpected event"),
963         }
964
965         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
966         assert_eq!(msg_events.len(), 2);
967         let node_0_closing_signed = match msg_events[0] {
968                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
969                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
970                         (*msg).clone()
971                 },
972                 _ => panic!("Unexpected event"),
973         };
974         match msg_events[1] {
975                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
976                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
977                 },
978                 _ => panic!("Unexpected event"),
979         }
980
981         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
982         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
983         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
984         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
985         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
986         assert!(node_0_none.is_none());
987
988         assert!(nodes[0].node.list_channels().is_empty());
989
990         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
991         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
992         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
993         assert!(nodes[1].node.list_channels().is_empty());
994         assert!(nodes[2].node.list_channels().is_empty());
995 }
996
997 fn do_test_shutdown_rebroadcast(recv_count: u8) {
998         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
999         // messages delivered prior to disconnect
1000         let chanmon_cfgs = create_chanmon_cfgs(3);
1001         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1002         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1003         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1004         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1005         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1006
1007         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1008
1009         nodes[1].node.close_channel(&chan_1.2).unwrap();
1010         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1011         if recv_count > 0 {
1012                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1013                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1014                 if recv_count > 1 {
1015                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1016                 }
1017         }
1018
1019         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1020         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1021
1022         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1023         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1024         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1025         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1026
1027         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1028         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1029         assert!(node_1_shutdown == node_1_2nd_shutdown);
1030
1031         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1032         let node_0_2nd_shutdown = if recv_count > 0 {
1033                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1034                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1035                 node_0_2nd_shutdown
1036         } else {
1037                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1038                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1039                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1040         };
1041         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1042
1043         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1044         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1045
1046         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1047         check_added_monitors!(nodes[2], 1);
1048         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1049         assert!(updates.update_add_htlcs.is_empty());
1050         assert!(updates.update_fail_htlcs.is_empty());
1051         assert!(updates.update_fail_malformed_htlcs.is_empty());
1052         assert!(updates.update_fee.is_none());
1053         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1054         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1055         check_added_monitors!(nodes[1], 1);
1056         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1057         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1058
1059         assert!(updates_2.update_add_htlcs.is_empty());
1060         assert!(updates_2.update_fail_htlcs.is_empty());
1061         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1062         assert!(updates_2.update_fee.is_none());
1063         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1064         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1065         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1066
1067         let events = nodes[0].node.get_and_clear_pending_events();
1068         assert_eq!(events.len(), 1);
1069         match events[0] {
1070                 Event::PaymentSent { ref payment_preimage } => {
1071                         assert_eq!(our_payment_preimage, *payment_preimage);
1072                 },
1073                 _ => panic!("Unexpected event"),
1074         }
1075
1076         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1077         if recv_count > 0 {
1078                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1079                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1080                 assert!(node_1_closing_signed.is_some());
1081         }
1082
1083         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1084         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1085
1086         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1087         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1088         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1089         if recv_count == 0 {
1090                 // If all closing_signeds weren't delivered we can just resume where we left off...
1091                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1092
1093                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1094                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1095                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1096
1097                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1098                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1099                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1100
1101                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1102                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1103
1104                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1105                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1106                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1107
1108                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1109                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1110                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1111                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1112                 assert!(node_0_none.is_none());
1113         } else {
1114                 // If one node, however, received + responded with an identical closing_signed we end
1115                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1116                 // There isn't really anything better we can do simply, but in the future we might
1117                 // explore storing a set of recently-closed channels that got disconnected during
1118                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1119                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1120                 // transaction.
1121                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1122
1123                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1124                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1125                 assert_eq!(msg_events.len(), 1);
1126                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1127                         match action {
1128                                 &ErrorAction::SendErrorMessage { ref msg } => {
1129                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1130                                         assert_eq!(msg.channel_id, chan_1.2);
1131                                 },
1132                                 _ => panic!("Unexpected event!"),
1133                         }
1134                 } else { panic!("Needed SendErrorMessage close"); }
1135
1136                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1137                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1138                 // closing_signed so we do it ourselves
1139                 check_closed_broadcast!(nodes[0], false);
1140                 check_added_monitors!(nodes[0], 1);
1141         }
1142
1143         assert!(nodes[0].node.list_channels().is_empty());
1144
1145         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1146         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1147         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1148         assert!(nodes[1].node.list_channels().is_empty());
1149         assert!(nodes[2].node.list_channels().is_empty());
1150 }
1151
1152 #[test]
1153 fn test_shutdown_rebroadcast() {
1154         do_test_shutdown_rebroadcast(0);
1155         do_test_shutdown_rebroadcast(1);
1156         do_test_shutdown_rebroadcast(2);
1157 }
1158
1159 #[test]
1160 fn fake_network_test() {
1161         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1162         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1163         let chanmon_cfgs = create_chanmon_cfgs(4);
1164         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1165         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1166         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1167
1168         // Create some initial channels
1169         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1170         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1171         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1172
1173         // Rebalance the network a bit by relaying one payment through all the channels...
1174         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1175         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1176         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1177         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1178
1179         // Send some more payments
1180         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1181         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1182         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1183
1184         // Test failure packets
1185         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1186         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1187
1188         // Add a new channel that skips 3
1189         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1190
1191         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1192         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1193         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1194         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1195         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1196         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1197         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1198
1199         // Do some rebalance loop payments, simultaneously
1200         let mut hops = Vec::with_capacity(3);
1201         hops.push(RouteHop {
1202                 pubkey: nodes[2].node.get_our_node_id(),
1203                 node_features: NodeFeatures::empty(),
1204                 short_channel_id: chan_2.0.contents.short_channel_id,
1205                 channel_features: ChannelFeatures::empty(),
1206                 fee_msat: 0,
1207                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1208         });
1209         hops.push(RouteHop {
1210                 pubkey: nodes[3].node.get_our_node_id(),
1211                 node_features: NodeFeatures::empty(),
1212                 short_channel_id: chan_3.0.contents.short_channel_id,
1213                 channel_features: ChannelFeatures::empty(),
1214                 fee_msat: 0,
1215                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1216         });
1217         hops.push(RouteHop {
1218                 pubkey: nodes[1].node.get_our_node_id(),
1219                 node_features: NodeFeatures::empty(),
1220                 short_channel_id: chan_4.0.contents.short_channel_id,
1221                 channel_features: ChannelFeatures::empty(),
1222                 fee_msat: 1000000,
1223                 cltv_expiry_delta: TEST_FINAL_CLTV,
1224         });
1225         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;
1226         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;
1227         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1228
1229         let mut hops = Vec::with_capacity(3);
1230         hops.push(RouteHop {
1231                 pubkey: nodes[3].node.get_our_node_id(),
1232                 node_features: NodeFeatures::empty(),
1233                 short_channel_id: chan_4.0.contents.short_channel_id,
1234                 channel_features: ChannelFeatures::empty(),
1235                 fee_msat: 0,
1236                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1237         });
1238         hops.push(RouteHop {
1239                 pubkey: nodes[2].node.get_our_node_id(),
1240                 node_features: NodeFeatures::empty(),
1241                 short_channel_id: chan_3.0.contents.short_channel_id,
1242                 channel_features: ChannelFeatures::empty(),
1243                 fee_msat: 0,
1244                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1245         });
1246         hops.push(RouteHop {
1247                 pubkey: nodes[1].node.get_our_node_id(),
1248                 node_features: NodeFeatures::empty(),
1249                 short_channel_id: chan_2.0.contents.short_channel_id,
1250                 channel_features: ChannelFeatures::empty(),
1251                 fee_msat: 1000000,
1252                 cltv_expiry_delta: TEST_FINAL_CLTV,
1253         });
1254         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;
1255         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;
1256         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1257
1258         // Claim the rebalances...
1259         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1260         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1261
1262         // Add a duplicate new channel from 2 to 4
1263         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1264
1265         // Send some payments across both channels
1266         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1267         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1268         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1269
1270
1271         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1272         let events = nodes[0].node.get_and_clear_pending_msg_events();
1273         assert_eq!(events.len(), 0);
1274         nodes[0].logger.assert_log("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);
1275
1276         //TODO: Test that routes work again here as we've been notified that the channel is full
1277
1278         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1279         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1280         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1281
1282         // Close down the channels...
1283         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1284         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1285         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1286         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1287         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1288 }
1289
1290 #[test]
1291 fn holding_cell_htlc_counting() {
1292         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1293         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1294         // commitment dance rounds.
1295         let chanmon_cfgs = create_chanmon_cfgs(3);
1296         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1297         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1298         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1299         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1300         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1301
1302         let mut payments = Vec::new();
1303         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1304                 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1305                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1306                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1307                 payments.push((payment_preimage, payment_hash));
1308         }
1309         check_added_monitors!(nodes[1], 1);
1310
1311         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1312         assert_eq!(events.len(), 1);
1313         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1314         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1315
1316         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1317         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1318         // another HTLC.
1319         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1320         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1321         unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { err },
1322                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
1323         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1324         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1325
1326         // This should also be true if we try to forward a payment.
1327         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1328         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1329         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1330         check_added_monitors!(nodes[0], 1);
1331
1332         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1333         assert_eq!(events.len(), 1);
1334         let payment_event = SendEvent::from_event(events.pop().unwrap());
1335         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1336
1337         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1338         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1339         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1340         // fails), the second will process the resulting failure and fail the HTLC backward.
1341         expect_pending_htlcs_forwardable!(nodes[1]);
1342         expect_pending_htlcs_forwardable!(nodes[1]);
1343         check_added_monitors!(nodes[1], 1);
1344
1345         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1346         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1347         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1348
1349         let events = nodes[0].node.get_and_clear_pending_msg_events();
1350         assert_eq!(events.len(), 1);
1351         match events[0] {
1352                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1353                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1354                 },
1355                 _ => panic!("Unexpected event"),
1356         }
1357
1358         let events = nodes[0].node.get_and_clear_pending_events();
1359         assert_eq!(events.len(), 1);
1360         match events[0] {
1361                 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1362                         assert_eq!(payment_hash, payment_hash_2);
1363                         assert!(!rejected_by_dest);
1364                 },
1365                 _ => panic!("Unexpected event"),
1366         }
1367
1368         // Now forward all the pending HTLCs and claim them back
1369         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1370         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1371         check_added_monitors!(nodes[2], 1);
1372
1373         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1374         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1375         check_added_monitors!(nodes[1], 1);
1376         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1377
1378         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1379         check_added_monitors!(nodes[1], 1);
1380         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1381
1382         for ref update in as_updates.update_add_htlcs.iter() {
1383                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1384         }
1385         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1386         check_added_monitors!(nodes[2], 1);
1387         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1388         check_added_monitors!(nodes[2], 1);
1389         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1390
1391         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1392         check_added_monitors!(nodes[1], 1);
1393         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1394         check_added_monitors!(nodes[1], 1);
1395         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1396
1397         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1398         check_added_monitors!(nodes[2], 1);
1399
1400         expect_pending_htlcs_forwardable!(nodes[2]);
1401
1402         let events = nodes[2].node.get_and_clear_pending_events();
1403         assert_eq!(events.len(), payments.len());
1404         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1405                 match event {
1406                         &Event::PaymentReceived { ref payment_hash, .. } => {
1407                                 assert_eq!(*payment_hash, *hash);
1408                         },
1409                         _ => panic!("Unexpected event"),
1410                 };
1411         }
1412
1413         for (preimage, _) in payments.drain(..) {
1414                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1415         }
1416
1417         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1418 }
1419
1420 #[test]
1421 fn duplicate_htlc_test() {
1422         // Test that we accept duplicate payment_hash HTLCs across the network and that
1423         // claiming/failing them are all separate and don't affect each other
1424         let chanmon_cfgs = create_chanmon_cfgs(6);
1425         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1426         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1427         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1428
1429         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1430         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1431         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1432         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1433         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1434         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1435
1436         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1437
1438         *nodes[0].network_payment_count.borrow_mut() -= 1;
1439         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1440
1441         *nodes[0].network_payment_count.borrow_mut() -= 1;
1442         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1443
1444         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1445         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1446         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1447 }
1448
1449 #[test]
1450 fn test_duplicate_htlc_different_direction_onchain() {
1451         // Test that ChannelMonitor doesn't generate 2 preimage txn
1452         // when we have 2 HTLCs with same preimage that go across a node
1453         // in opposite directions.
1454         let chanmon_cfgs = create_chanmon_cfgs(2);
1455         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1456         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1457         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1458
1459         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1460
1461         // balancing
1462         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1463
1464         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1465
1466         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1467         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1468
1469         // Provide preimage to node 0 by claiming payment
1470         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1471         check_added_monitors!(nodes[0], 1);
1472
1473         // Broadcast node 1 commitment txn
1474         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1475
1476         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1477         let mut has_both_htlcs = 0; // check htlcs match ones committed
1478         for outp in remote_txn[0].output.iter() {
1479                 if outp.value == 800_000 / 1000 {
1480                         has_both_htlcs += 1;
1481                 } else if outp.value == 900_000 / 1000 {
1482                         has_both_htlcs += 1;
1483                 }
1484         }
1485         assert_eq!(has_both_htlcs, 2);
1486
1487         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1488         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1489         check_added_monitors!(nodes[0], 1);
1490
1491         // Check we only broadcast 1 timeout tx
1492         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1493         let htlc_pair = if claim_txn[0].output[0].value == 800_000 / 1000 { (claim_txn[0].clone(), claim_txn[1].clone()) } else { (claim_txn[1].clone(), claim_txn[0].clone()) };
1494         assert_eq!(claim_txn.len(), 5);
1495         check_spends!(claim_txn[2], chan_1.3);
1496         check_spends!(claim_txn[3], claim_txn[2]);
1497         assert_eq!(htlc_pair.0.input.len(), 1);
1498         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1499         check_spends!(htlc_pair.0, remote_txn[0]);
1500         assert_eq!(htlc_pair.1.input.len(), 1);
1501         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1502         check_spends!(htlc_pair.1, remote_txn[0]);
1503
1504         let events = nodes[0].node.get_and_clear_pending_msg_events();
1505         assert_eq!(events.len(), 2);
1506         for e in events {
1507                 match e {
1508                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1509                         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, .. } } => {
1510                                 assert!(update_add_htlcs.is_empty());
1511                                 assert!(update_fail_htlcs.is_empty());
1512                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1513                                 assert!(update_fail_malformed_htlcs.is_empty());
1514                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1515                         },
1516                         _ => panic!("Unexpected event"),
1517                 }
1518         }
1519 }
1520
1521 fn do_channel_reserve_test(test_recv: bool) {
1522
1523         let chanmon_cfgs = create_chanmon_cfgs(3);
1524         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1525         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1526         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1527         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1528         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1529
1530         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1531         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1532
1533         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1534         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1535
1536         macro_rules! get_route_and_payment_hash {
1537                 ($recv_value: expr) => {{
1538                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1539                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1540                         (route, payment_hash, payment_preimage)
1541                 }}
1542         };
1543
1544         macro_rules! expect_forward {
1545                 ($node: expr) => {{
1546                         let mut events = $node.node.get_and_clear_pending_msg_events();
1547                         assert_eq!(events.len(), 1);
1548                         check_added_monitors!($node, 1);
1549                         let payment_event = SendEvent::from_event(events.remove(0));
1550                         payment_event
1551                 }}
1552         }
1553
1554         let feemsat = 239; // somehow we know?
1555         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1556
1557         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1558
1559         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1560         {
1561                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1562                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1563                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1564                         assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
1565                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1566                 nodes[0].logger.assert_log("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);
1567         }
1568
1569         let mut htlc_id = 0;
1570         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1571         // nodes[0]'s wealth
1572         loop {
1573                 let amt_msat = recv_value_0 + total_fee_msat;
1574                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1575                         break;
1576                 }
1577                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1578                 htlc_id += 1;
1579
1580                 let (stat01_, stat11_, stat12_, stat22_) = (
1581                         get_channel_value_stat!(nodes[0], chan_1.2),
1582                         get_channel_value_stat!(nodes[1], chan_1.2),
1583                         get_channel_value_stat!(nodes[1], chan_2.2),
1584                         get_channel_value_stat!(nodes[2], chan_2.2),
1585                 );
1586
1587                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1588                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1589                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1590                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1591                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1592         }
1593
1594         {
1595                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1596                 // attempt to get channel_reserve violation
1597                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1598                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1599                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1600                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1601                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1602         }
1603
1604         // adding pending output
1605         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1606         let amt_msat_1 = recv_value_1 + total_fee_msat;
1607
1608         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1609         let payment_event_1 = {
1610                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1611                 check_added_monitors!(nodes[0], 1);
1612
1613                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1614                 assert_eq!(events.len(), 1);
1615                 SendEvent::from_event(events.remove(0))
1616         };
1617         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1618
1619         // channel reserve test with htlc pending output > 0
1620         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1621         {
1622                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1623                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1624                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1625                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1626                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1627         }
1628
1629         {
1630                 // test channel_reserve test on nodes[1] side
1631                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1632
1633                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1634                 let secp_ctx = Secp256k1::new();
1635                 let session_priv = SecretKey::from_slice(&{
1636                         let mut session_key = [0; 32];
1637                         let mut rng = thread_rng();
1638                         rng.fill_bytes(&mut session_key);
1639                         session_key
1640                 }).expect("RNG is bad!");
1641
1642                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1643                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1644                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], recv_value_2 + 1, &None, cur_height).unwrap();
1645                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1646                 let msg = msgs::UpdateAddHTLC {
1647                         channel_id: chan_1.2,
1648                         htlc_id,
1649                         amount_msat: htlc_msat,
1650                         payment_hash: our_payment_hash,
1651                         cltv_expiry: htlc_cltv,
1652                         onion_routing_packet: onion_packet,
1653                 };
1654
1655                 if test_recv {
1656                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1657                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1658                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1659                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1660                         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1661                         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1662                         check_added_monitors!(nodes[1], 1);
1663                         return;
1664                 }
1665         }
1666
1667         // split the rest to test holding cell
1668         let recv_value_21 = recv_value_2/2;
1669         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1670         {
1671                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1672                 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), stat.channel_reserve_msat);
1673         }
1674
1675         // now see if they go through on both sides
1676         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1677         // but this will stuck in the holding cell
1678         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
1679         check_added_monitors!(nodes[0], 0);
1680         let events = nodes[0].node.get_and_clear_pending_events();
1681         assert_eq!(events.len(), 0);
1682
1683         // test with outbound holding cell amount > 0
1684         {
1685                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1686                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1687                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1688                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1689                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1690         }
1691
1692         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1693         // this will also stuck in the holding cell
1694         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
1695         check_added_monitors!(nodes[0], 0);
1696         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1697         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1698
1699         // flush the pending htlc
1700         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1701         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1702         check_added_monitors!(nodes[1], 1);
1703
1704         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1705         check_added_monitors!(nodes[0], 1);
1706         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1707
1708         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1709         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1710         // No commitment_signed so get_event_msg's assert(len == 1) passes
1711         check_added_monitors!(nodes[0], 1);
1712
1713         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1714         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1715         check_added_monitors!(nodes[1], 1);
1716
1717         expect_pending_htlcs_forwardable!(nodes[1]);
1718
1719         let ref payment_event_11 = expect_forward!(nodes[1]);
1720         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1721         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1722
1723         expect_pending_htlcs_forwardable!(nodes[2]);
1724         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1725
1726         // flush the htlcs in the holding cell
1727         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1728         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1729         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1730         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1731         expect_pending_htlcs_forwardable!(nodes[1]);
1732
1733         let ref payment_event_3 = expect_forward!(nodes[1]);
1734         assert_eq!(payment_event_3.msgs.len(), 2);
1735         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1736         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1737
1738         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1739         expect_pending_htlcs_forwardable!(nodes[2]);
1740
1741         let events = nodes[2].node.get_and_clear_pending_events();
1742         assert_eq!(events.len(), 2);
1743         match events[0] {
1744                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1745                         assert_eq!(our_payment_hash_21, *payment_hash);
1746                         assert_eq!(*payment_secret, None);
1747                         assert_eq!(recv_value_21, amt);
1748                 },
1749                 _ => panic!("Unexpected event"),
1750         }
1751         match events[1] {
1752                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1753                         assert_eq!(our_payment_hash_22, *payment_hash);
1754                         assert_eq!(None, *payment_secret);
1755                         assert_eq!(recv_value_22, amt);
1756                 },
1757                 _ => panic!("Unexpected event"),
1758         }
1759
1760         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1761         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1762         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1763
1764         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);
1765         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1766         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1767         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1768
1769         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1770         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1771 }
1772
1773 #[test]
1774 fn channel_reserve_test() {
1775         do_channel_reserve_test(false);
1776         do_channel_reserve_test(true);
1777 }
1778
1779 #[test]
1780 fn channel_reserve_in_flight_removes() {
1781         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1782         // can send to its counterparty, but due to update ordering, the other side may not yet have
1783         // considered those HTLCs fully removed.
1784         // This tests that we don't count HTLCs which will not be included in the next remote
1785         // commitment transaction towards the reserve value (as it implies no commitment transaction
1786         // will be generated which violates the remote reserve value).
1787         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1788         // To test this we:
1789         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1790         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1791         //    you only consider the value of the first HTLC, it may not),
1792         //  * start routing a third HTLC from A to B,
1793         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1794         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1795         //  * deliver the first fulfill from B
1796         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1797         //    claim,
1798         //  * deliver A's response CS and RAA.
1799         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1800         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1801         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1802         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1803         let chanmon_cfgs = create_chanmon_cfgs(2);
1804         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1805         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1806         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1807         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1808
1809         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1810         // Route the first two HTLCs.
1811         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1812         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1813
1814         // Start routing the third HTLC (this is just used to get everyone in the right state).
1815         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1816         let send_1 = {
1817                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1818                 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
1819                 check_added_monitors!(nodes[0], 1);
1820                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1821                 assert_eq!(events.len(), 1);
1822                 SendEvent::from_event(events.remove(0))
1823         };
1824
1825         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1826         // initial fulfill/CS.
1827         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1828         check_added_monitors!(nodes[1], 1);
1829         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1830
1831         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1832         // remove the second HTLC when we send the HTLC back from B to A.
1833         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
1834         check_added_monitors!(nodes[1], 1);
1835         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1836
1837         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1838         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1839         check_added_monitors!(nodes[0], 1);
1840         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1841         expect_payment_sent!(nodes[0], payment_preimage_1);
1842
1843         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1844         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1845         check_added_monitors!(nodes[1], 1);
1846         // B is already AwaitingRAA, so cant generate a CS here
1847         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1848
1849         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1850         check_added_monitors!(nodes[1], 1);
1851         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1852
1853         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1854         check_added_monitors!(nodes[0], 1);
1855         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1856
1857         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1858         check_added_monitors!(nodes[1], 1);
1859         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1860
1861         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1862         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1863         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1864         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1865         // on-chain as necessary).
1866         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1867         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1868         check_added_monitors!(nodes[0], 1);
1869         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1870         expect_payment_sent!(nodes[0], payment_preimage_2);
1871
1872         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1873         check_added_monitors!(nodes[1], 1);
1874         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1875
1876         expect_pending_htlcs_forwardable!(nodes[1]);
1877         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1878
1879         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1880         // resolve the second HTLC from A's point of view.
1881         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1882         check_added_monitors!(nodes[0], 1);
1883         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1884
1885         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1886         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1887         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1888         let send_2 = {
1889                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1890                 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
1891                 check_added_monitors!(nodes[1], 1);
1892                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1893                 assert_eq!(events.len(), 1);
1894                 SendEvent::from_event(events.remove(0))
1895         };
1896
1897         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1898         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1899         check_added_monitors!(nodes[0], 1);
1900         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1901
1902         // Now just resolve all the outstanding messages/HTLCs for completeness...
1903
1904         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1905         check_added_monitors!(nodes[1], 1);
1906         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1907
1908         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1909         check_added_monitors!(nodes[1], 1);
1910
1911         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1912         check_added_monitors!(nodes[0], 1);
1913         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1914
1915         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1916         check_added_monitors!(nodes[1], 1);
1917         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1918
1919         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1920         check_added_monitors!(nodes[0], 1);
1921
1922         expect_pending_htlcs_forwardable!(nodes[0]);
1923         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1924
1925         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1926         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1927 }
1928
1929 #[test]
1930 fn channel_monitor_network_test() {
1931         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1932         // tests that ChannelMonitor is able to recover from various states.
1933         let chanmon_cfgs = create_chanmon_cfgs(5);
1934         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1935         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1936         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1937
1938         // Create some initial channels
1939         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1940         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1941         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1942         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1943
1944         // Rebalance the network a bit by relaying one payment through all the channels...
1945         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1946         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1947         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1948         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1949
1950         // Simple case with no pending HTLCs:
1951         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1952         check_added_monitors!(nodes[1], 1);
1953         {
1954                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1955                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1956                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1957                 check_added_monitors!(nodes[0], 1);
1958                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1959         }
1960         get_announce_close_broadcast_events(&nodes, 0, 1);
1961         assert_eq!(nodes[0].node.list_channels().len(), 0);
1962         assert_eq!(nodes[1].node.list_channels().len(), 1);
1963
1964         // One pending HTLC is discarded by the force-close:
1965         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1966
1967         // Simple case of one pending HTLC to HTLC-Timeout
1968         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1969         check_added_monitors!(nodes[1], 1);
1970         {
1971                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1972                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1973                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1974                 check_added_monitors!(nodes[2], 1);
1975                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1976         }
1977         get_announce_close_broadcast_events(&nodes, 1, 2);
1978         assert_eq!(nodes[1].node.list_channels().len(), 0);
1979         assert_eq!(nodes[2].node.list_channels().len(), 1);
1980
1981         macro_rules! claim_funds {
1982                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1983                         {
1984                                 assert!($node.node.claim_funds($preimage, &None, $amount));
1985                                 check_added_monitors!($node, 1);
1986
1987                                 let events = $node.node.get_and_clear_pending_msg_events();
1988                                 assert_eq!(events.len(), 1);
1989                                 match events[0] {
1990                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1991                                                 assert!(update_add_htlcs.is_empty());
1992                                                 assert!(update_fail_htlcs.is_empty());
1993                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1994                                         },
1995                                         _ => panic!("Unexpected event"),
1996                                 };
1997                         }
1998                 }
1999         }
2000
2001         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2002         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2003         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2004         check_added_monitors!(nodes[2], 1);
2005         let node2_commitment_txid;
2006         {
2007                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2008                 node2_commitment_txid = node_txn[0].txid();
2009
2010                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2011                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2012
2013                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2014                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2015                 check_added_monitors!(nodes[3], 1);
2016
2017                 check_preimage_claim(&nodes[3], &node_txn);
2018         }
2019         get_announce_close_broadcast_events(&nodes, 2, 3);
2020         assert_eq!(nodes[2].node.list_channels().len(), 0);
2021         assert_eq!(nodes[3].node.list_channels().len(), 1);
2022
2023         { // Cheat and reset nodes[4]'s height to 1
2024                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2025                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2026         }
2027
2028         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2029         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2030         // One pending HTLC to time out:
2031         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2032         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2033         // buffer space).
2034
2035         {
2036                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2037                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2038                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2039                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2040                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2041                 }
2042                 check_added_monitors!(nodes[3], 1);
2043
2044                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2045                 {
2046                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2047                         node_txn.retain(|tx| {
2048                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2049                                         false
2050                                 } else { true }
2051                         });
2052                 }
2053
2054                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2055
2056                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2057                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2058
2059                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2060
2061                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2062                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2063                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2064                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2065                 }
2066
2067                 check_added_monitors!(nodes[4], 1);
2068                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2069
2070                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2071                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2072
2073                 check_preimage_claim(&nodes[4], &node_txn);
2074         }
2075         get_announce_close_broadcast_events(&nodes, 3, 4);
2076         assert_eq!(nodes[3].node.list_channels().len(), 0);
2077         assert_eq!(nodes[4].node.list_channels().len(), 0);
2078 }
2079
2080 #[test]
2081 fn test_justice_tx() {
2082         // Test justice txn built on revoked HTLC-Success tx, against both sides
2083         let mut alice_config = UserConfig::default();
2084         alice_config.channel_options.announced_channel = true;
2085         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2086         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2087         let mut bob_config = UserConfig::default();
2088         bob_config.channel_options.announced_channel = true;
2089         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2090         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2091         let user_cfgs = [Some(alice_config), Some(bob_config)];
2092         let chanmon_cfgs = create_chanmon_cfgs(2);
2093         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2094         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2095         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2096         // Create some new channels:
2097         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2098
2099         // A pending HTLC which will be revoked:
2100         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2101         // Get the will-be-revoked local txn from nodes[0]
2102         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2103         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2104         assert_eq!(revoked_local_txn[0].input.len(), 1);
2105         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2106         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2107         assert_eq!(revoked_local_txn[1].input.len(), 1);
2108         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2109         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2110         // Revoke the old state
2111         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2112
2113         {
2114                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2115                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2116                 {
2117                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2118                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2119                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2120
2121                         check_spends!(node_txn[0], revoked_local_txn[0]);
2122                         node_txn.swap_remove(0);
2123                         node_txn.truncate(1);
2124                 }
2125                 check_added_monitors!(nodes[1], 1);
2126                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2127
2128                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2129                 // Verify broadcast of revoked HTLC-timeout
2130                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2131                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2132                 check_added_monitors!(nodes[0], 1);
2133                 // Broadcast revoked HTLC-timeout on node 1
2134                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2135                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2136         }
2137         get_announce_close_broadcast_events(&nodes, 0, 1);
2138
2139         assert_eq!(nodes[0].node.list_channels().len(), 0);
2140         assert_eq!(nodes[1].node.list_channels().len(), 0);
2141
2142         // We test justice_tx build by A on B's revoked HTLC-Success tx
2143         // Create some new channels:
2144         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2145         {
2146                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2147                 node_txn.clear();
2148         }
2149
2150         // A pending HTLC which will be revoked:
2151         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2152         // Get the will-be-revoked local txn from B
2153         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2154         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2155         assert_eq!(revoked_local_txn[0].input.len(), 1);
2156         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2157         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2158         // Revoke the old state
2159         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2160         {
2161                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2162                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2163                 {
2164                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2165                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2166                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2167
2168                         check_spends!(node_txn[0], revoked_local_txn[0]);
2169                         node_txn.swap_remove(0);
2170                 }
2171                 check_added_monitors!(nodes[0], 1);
2172                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2173
2174                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2175                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2176                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2177                 check_added_monitors!(nodes[1], 1);
2178                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2179                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2180         }
2181         get_announce_close_broadcast_events(&nodes, 0, 1);
2182         assert_eq!(nodes[0].node.list_channels().len(), 0);
2183         assert_eq!(nodes[1].node.list_channels().len(), 0);
2184 }
2185
2186 #[test]
2187 fn revoked_output_claim() {
2188         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2189         // transaction is broadcast by its counterparty
2190         let chanmon_cfgs = create_chanmon_cfgs(2);
2191         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2192         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2193         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2194         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2195         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2196         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2197         assert_eq!(revoked_local_txn.len(), 1);
2198         // Only output is the full channel value back to nodes[0]:
2199         assert_eq!(revoked_local_txn[0].output.len(), 1);
2200         // Send a payment through, updating everyone's latest commitment txn
2201         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2202
2203         // Inform nodes[1] that nodes[0] broadcast a stale tx
2204         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2205         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2206         check_added_monitors!(nodes[1], 1);
2207         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2208         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2209
2210         check_spends!(node_txn[0], revoked_local_txn[0]);
2211         check_spends!(node_txn[1], chan_1.3);
2212
2213         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2214         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2215         get_announce_close_broadcast_events(&nodes, 0, 1);
2216         check_added_monitors!(nodes[0], 1)
2217 }
2218
2219 #[test]
2220 fn claim_htlc_outputs_shared_tx() {
2221         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2222         let chanmon_cfgs = create_chanmon_cfgs(2);
2223         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2224         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2225         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2226
2227         // Create some new channel:
2228         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2229
2230         // Rebalance the network to generate htlc in the two directions
2231         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2232         // 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
2233         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2234         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2235
2236         // Get the will-be-revoked local txn from node[0]
2237         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2238         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2239         assert_eq!(revoked_local_txn[0].input.len(), 1);
2240         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2241         assert_eq!(revoked_local_txn[1].input.len(), 1);
2242         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2243         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2244         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2245
2246         //Revoke the old state
2247         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2248
2249         {
2250                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2251                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2252                 check_added_monitors!(nodes[0], 1);
2253                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2254                 check_added_monitors!(nodes[1], 1);
2255                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2256
2257                 let events = nodes[1].node.get_and_clear_pending_events();
2258                 assert_eq!(events.len(), 1);
2259                 match events[0] {
2260                         Event::PaymentFailed { payment_hash, .. } => {
2261                                 assert_eq!(payment_hash, payment_hash_2);
2262                         },
2263                         _ => panic!("Unexpected event"),
2264                 }
2265
2266                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2267                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2268
2269                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2270                 check_spends!(node_txn[0], revoked_local_txn[0]);
2271
2272                 let mut witness_lens = BTreeSet::new();
2273                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2274                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2275                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2276                 assert_eq!(witness_lens.len(), 3);
2277                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2278                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2279                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2280
2281                 // Next nodes[1] broadcasts its current local tx state:
2282                 assert_eq!(node_txn[1].input.len(), 1);
2283                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2284
2285                 assert_eq!(node_txn[2].input.len(), 1);
2286                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2287                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2288                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2289                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2290                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2291         }
2292         get_announce_close_broadcast_events(&nodes, 0, 1);
2293         assert_eq!(nodes[0].node.list_channels().len(), 0);
2294         assert_eq!(nodes[1].node.list_channels().len(), 0);
2295 }
2296
2297 #[test]
2298 fn claim_htlc_outputs_single_tx() {
2299         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2300         let chanmon_cfgs = create_chanmon_cfgs(2);
2301         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2302         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2303         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2304
2305         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2306
2307         // Rebalance the network to generate htlc in the two directions
2308         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2309         // 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
2310         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2311         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2312         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2313
2314         // Get the will-be-revoked local txn from node[0]
2315         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2316
2317         //Revoke the old state
2318         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2319
2320         {
2321                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2322                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2323                 check_added_monitors!(nodes[0], 1);
2324                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2325                 check_added_monitors!(nodes[1], 1);
2326                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2327
2328                 let events = nodes[1].node.get_and_clear_pending_events();
2329                 assert_eq!(events.len(), 1);
2330                 match events[0] {
2331                         Event::PaymentFailed { payment_hash, .. } => {
2332                                 assert_eq!(payment_hash, payment_hash_2);
2333                         },
2334                         _ => panic!("Unexpected event"),
2335                 }
2336
2337                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2338                 assert_eq!(node_txn.len(), 9);
2339                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2340                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2341                 // ChannelMonitor: bumped justice tx, after one increase, bumps on HTLC aren't generated not being substantial anymore, bump on revoked to_local isn't generated due to more room for expiration (2)
2342                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2343
2344                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2345                 assert_eq!(node_txn[2].input.len(), 1);
2346                 check_spends!(node_txn[2], chan_1.3);
2347                 assert_eq!(node_txn[3].input.len(), 1);
2348                 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2349                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2350                 check_spends!(node_txn[3], node_txn[2]);
2351
2352                 // Justice transactions are indices 1-2-4
2353                 assert_eq!(node_txn[0].input.len(), 1);
2354                 assert_eq!(node_txn[1].input.len(), 1);
2355                 assert_eq!(node_txn[4].input.len(), 1);
2356
2357                 check_spends!(node_txn[0], revoked_local_txn[0]);
2358                 check_spends!(node_txn[1], revoked_local_txn[0]);
2359                 check_spends!(node_txn[4], revoked_local_txn[0]);
2360
2361                 let mut witness_lens = BTreeSet::new();
2362                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2363                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2364                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2365                 assert_eq!(witness_lens.len(), 3);
2366                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2367                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2368                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2369         }
2370         get_announce_close_broadcast_events(&nodes, 0, 1);
2371         assert_eq!(nodes[0].node.list_channels().len(), 0);
2372         assert_eq!(nodes[1].node.list_channels().len(), 0);
2373 }
2374
2375 #[test]
2376 fn test_htlc_on_chain_success() {
2377         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2378         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2379         // broadcasting the right event to other nodes in payment path.
2380         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2381         // A --------------------> B ----------------------> C (preimage)
2382         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2383         // commitment transaction was broadcast.
2384         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2385         // towards B.
2386         // B should be able to claim via preimage if A then broadcasts its local tx.
2387         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2388         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2389         // PaymentSent event).
2390
2391         let chanmon_cfgs = create_chanmon_cfgs(3);
2392         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2393         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2394         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2395
2396         // Create some initial channels
2397         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2398         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2399
2400         // Rebalance the network a bit by relaying one payment through all the channels...
2401         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2402         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2403
2404         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2405         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2406         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2407
2408         // Broadcast legit commitment tx from C on B's chain
2409         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2410         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2411         assert_eq!(commitment_tx.len(), 1);
2412         check_spends!(commitment_tx[0], chan_2.3);
2413         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2414         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2415         check_added_monitors!(nodes[2], 2);
2416         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2417         assert!(updates.update_add_htlcs.is_empty());
2418         assert!(updates.update_fail_htlcs.is_empty());
2419         assert!(updates.update_fail_malformed_htlcs.is_empty());
2420         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2421
2422         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2423         check_closed_broadcast!(nodes[2], false);
2424         check_added_monitors!(nodes[2], 1);
2425         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)
2426         assert_eq!(node_txn.len(), 5);
2427         assert_eq!(node_txn[0], node_txn[3]);
2428         assert_eq!(node_txn[1], node_txn[4]);
2429         assert_eq!(node_txn[2], commitment_tx[0]);
2430         check_spends!(node_txn[0], commitment_tx[0]);
2431         check_spends!(node_txn[1], commitment_tx[0]);
2432         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2433         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2434         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2435         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2436         assert_eq!(node_txn[0].lock_time, 0);
2437         assert_eq!(node_txn[1].lock_time, 0);
2438
2439         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2440         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2441         {
2442                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2443                 assert_eq!(added_monitors.len(), 1);
2444                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2445                 added_monitors.clear();
2446         }
2447         let events = nodes[1].node.get_and_clear_pending_msg_events();
2448         {
2449                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2450                 assert_eq!(added_monitors.len(), 2);
2451                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2452                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2453                 added_monitors.clear();
2454         }
2455         assert_eq!(events.len(), 2);
2456         match events[0] {
2457                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2458                 _ => panic!("Unexpected event"),
2459         }
2460         match events[1] {
2461                 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, .. } } => {
2462                         assert!(update_add_htlcs.is_empty());
2463                         assert!(update_fail_htlcs.is_empty());
2464                         assert_eq!(update_fulfill_htlcs.len(), 1);
2465                         assert!(update_fail_malformed_htlcs.is_empty());
2466                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2467                 },
2468                 _ => panic!("Unexpected event"),
2469         };
2470         macro_rules! check_tx_local_broadcast {
2471                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2472                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2473                         assert_eq!(node_txn.len(), 5);
2474                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2475                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2476                         check_spends!(node_txn[0], $commitment_tx);
2477                         check_spends!(node_txn[1], $commitment_tx);
2478                         assert_ne!(node_txn[0].lock_time, 0);
2479                         assert_ne!(node_txn[1].lock_time, 0);
2480                         if $htlc_offered {
2481                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2482                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2483                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2484                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2485                         } else {
2486                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2487                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2488                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2489                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2490                         }
2491                         check_spends!(node_txn[2], $chan_tx);
2492                         check_spends!(node_txn[3], node_txn[2]);
2493                         check_spends!(node_txn[4], node_txn[2]);
2494                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2495                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2496                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2497                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2498                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2499                         assert_ne!(node_txn[3].lock_time, 0);
2500                         assert_ne!(node_txn[4].lock_time, 0);
2501                         node_txn.clear();
2502                 } }
2503         }
2504         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2505         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2506         // timeout-claim of the output that nodes[2] just claimed via success.
2507         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2508
2509         // Broadcast legit commitment tx from A on B's chain
2510         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2511         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2512         check_spends!(commitment_tx[0], chan_1.3);
2513         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2514         check_closed_broadcast!(nodes[1], false);
2515         check_added_monitors!(nodes[1], 1);
2516         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2517         assert_eq!(node_txn.len(), 4);
2518         check_spends!(node_txn[0], commitment_tx[0]);
2519         assert_eq!(node_txn[0].input.len(), 2);
2520         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2521         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2522         assert_eq!(node_txn[0].lock_time, 0);
2523         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2524         check_spends!(node_txn[1], chan_1.3);
2525         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2526         check_spends!(node_txn[2], node_txn[1]);
2527         check_spends!(node_txn[3], node_txn[1]);
2528         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2529         // we already checked the same situation with A.
2530
2531         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2532         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2533         check_closed_broadcast!(nodes[0], false);
2534         check_added_monitors!(nodes[0], 1);
2535         let events = nodes[0].node.get_and_clear_pending_events();
2536         assert_eq!(events.len(), 2);
2537         let mut first_claimed = false;
2538         for event in events {
2539                 match event {
2540                         Event::PaymentSent { payment_preimage } => {
2541                                 if payment_preimage == our_payment_preimage {
2542                                         assert!(!first_claimed);
2543                                         first_claimed = true;
2544                                 } else {
2545                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2546                                 }
2547                         },
2548                         _ => panic!("Unexpected event"),
2549                 }
2550         }
2551         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2552 }
2553
2554 #[test]
2555 fn test_htlc_on_chain_timeout() {
2556         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2557         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2558         // broadcasting the right event to other nodes in payment path.
2559         // A ------------------> B ----------------------> C (timeout)
2560         //    B's commitment tx                 C's commitment tx
2561         //            \                                  \
2562         //         B's HTLC timeout tx               B's timeout tx
2563
2564         let chanmon_cfgs = create_chanmon_cfgs(3);
2565         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2566         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2567         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2568
2569         // Create some intial channels
2570         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2571         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2572
2573         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2574         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2575         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2576
2577         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2578         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2579
2580         // Broadcast legit commitment tx from C on B's chain
2581         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2582         check_spends!(commitment_tx[0], chan_2.3);
2583         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2584         check_added_monitors!(nodes[2], 0);
2585         expect_pending_htlcs_forwardable!(nodes[2]);
2586         check_added_monitors!(nodes[2], 1);
2587
2588         let events = nodes[2].node.get_and_clear_pending_msg_events();
2589         assert_eq!(events.len(), 1);
2590         match events[0] {
2591                 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, .. } } => {
2592                         assert!(update_add_htlcs.is_empty());
2593                         assert!(!update_fail_htlcs.is_empty());
2594                         assert!(update_fulfill_htlcs.is_empty());
2595                         assert!(update_fail_malformed_htlcs.is_empty());
2596                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2597                 },
2598                 _ => panic!("Unexpected event"),
2599         };
2600         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2601         check_closed_broadcast!(nodes[2], false);
2602         check_added_monitors!(nodes[2], 1);
2603         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2604         assert_eq!(node_txn.len(), 1);
2605         check_spends!(node_txn[0], chan_2.3);
2606         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2607
2608         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2609         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2610         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2611         let timeout_tx;
2612         {
2613                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2614                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2615                 assert_eq!(node_txn[1], node_txn[3]);
2616                 assert_eq!(node_txn[2], node_txn[4]);
2617
2618                 check_spends!(node_txn[0], commitment_tx[0]);
2619                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2620
2621                 check_spends!(node_txn[1], chan_2.3);
2622                 check_spends!(node_txn[2], node_txn[1]);
2623                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2624                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2625
2626                 timeout_tx = node_txn[0].clone();
2627                 node_txn.clear();
2628         }
2629
2630         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2631         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2632         check_added_monitors!(nodes[1], 1);
2633         check_closed_broadcast!(nodes[1], false);
2634
2635         expect_pending_htlcs_forwardable!(nodes[1]);
2636         check_added_monitors!(nodes[1], 1);
2637         let events = nodes[1].node.get_and_clear_pending_msg_events();
2638         assert_eq!(events.len(), 1);
2639         match events[0] {
2640                 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, .. } } => {
2641                         assert!(update_add_htlcs.is_empty());
2642                         assert!(!update_fail_htlcs.is_empty());
2643                         assert!(update_fulfill_htlcs.is_empty());
2644                         assert!(update_fail_malformed_htlcs.is_empty());
2645                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2646                 },
2647                 _ => panic!("Unexpected event"),
2648         };
2649         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // Well... here we detect our own htlc_timeout_tx so no tx to be generated
2650         assert_eq!(node_txn.len(), 0);
2651
2652         // Broadcast legit commitment tx from B on A's chain
2653         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2654         check_spends!(commitment_tx[0], chan_1.3);
2655
2656         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2657         check_closed_broadcast!(nodes[0], false);
2658         check_added_monitors!(nodes[0], 1);
2659         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2660         assert_eq!(node_txn.len(), 3);
2661         check_spends!(node_txn[0], commitment_tx[0]);
2662         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2663         check_spends!(node_txn[1], chan_1.3);
2664         check_spends!(node_txn[2], node_txn[1]);
2665         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2666         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2667 }
2668
2669 #[test]
2670 fn test_simple_commitment_revoked_fail_backward() {
2671         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2672         // and fail backward accordingly.
2673
2674         let chanmon_cfgs = create_chanmon_cfgs(3);
2675         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2676         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2677         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2678
2679         // Create some initial channels
2680         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2681         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2682
2683         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2684         // Get the will-be-revoked local txn from nodes[2]
2685         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2686         // Revoke the old state
2687         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2688
2689         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2690
2691         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2692         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2693         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2694         check_added_monitors!(nodes[1], 1);
2695         check_closed_broadcast!(nodes[1], false);
2696
2697         expect_pending_htlcs_forwardable!(nodes[1]);
2698         check_added_monitors!(nodes[1], 1);
2699         let events = nodes[1].node.get_and_clear_pending_msg_events();
2700         assert_eq!(events.len(), 1);
2701         match events[0] {
2702                 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, .. } } => {
2703                         assert!(update_add_htlcs.is_empty());
2704                         assert_eq!(update_fail_htlcs.len(), 1);
2705                         assert!(update_fulfill_htlcs.is_empty());
2706                         assert!(update_fail_malformed_htlcs.is_empty());
2707                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2708
2709                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2710                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2711
2712                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2713                         assert_eq!(events.len(), 1);
2714                         match events[0] {
2715                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2716                                 _ => panic!("Unexpected event"),
2717                         }
2718                         let events = nodes[0].node.get_and_clear_pending_events();
2719                         assert_eq!(events.len(), 1);
2720                         match events[0] {
2721                                 Event::PaymentFailed { .. } => {},
2722                                 _ => panic!("Unexpected event"),
2723                         }
2724                 },
2725                 _ => panic!("Unexpected event"),
2726         }
2727 }
2728
2729 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2730         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2731         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2732         // commitment transaction anymore.
2733         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2734         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2735         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2736         // technically disallowed and we should probably handle it reasonably.
2737         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2738         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2739         // transactions:
2740         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2741         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2742         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2743         //   and once they revoke the previous commitment transaction (allowing us to send a new
2744         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2745         let chanmon_cfgs = create_chanmon_cfgs(3);
2746         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2747         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2748         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2749
2750         // Create some initial channels
2751         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2752         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2753
2754         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2755         // Get the will-be-revoked local txn from nodes[2]
2756         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2757         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2758         // Revoke the old state
2759         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2760
2761         let value = if use_dust {
2762                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2763                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2764                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2765         } else { 3000000 };
2766
2767         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2768         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2769         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2770
2771         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
2772         expect_pending_htlcs_forwardable!(nodes[2]);
2773         check_added_monitors!(nodes[2], 1);
2774         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2775         assert!(updates.update_add_htlcs.is_empty());
2776         assert!(updates.update_fulfill_htlcs.is_empty());
2777         assert!(updates.update_fail_malformed_htlcs.is_empty());
2778         assert_eq!(updates.update_fail_htlcs.len(), 1);
2779         assert!(updates.update_fee.is_none());
2780         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2781         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2782         // Drop the last RAA from 3 -> 2
2783
2784         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
2785         expect_pending_htlcs_forwardable!(nodes[2]);
2786         check_added_monitors!(nodes[2], 1);
2787         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2788         assert!(updates.update_add_htlcs.is_empty());
2789         assert!(updates.update_fulfill_htlcs.is_empty());
2790         assert!(updates.update_fail_malformed_htlcs.is_empty());
2791         assert_eq!(updates.update_fail_htlcs.len(), 1);
2792         assert!(updates.update_fee.is_none());
2793         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2794         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2795         check_added_monitors!(nodes[1], 1);
2796         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2797         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2798         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2799         check_added_monitors!(nodes[2], 1);
2800
2801         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
2802         expect_pending_htlcs_forwardable!(nodes[2]);
2803         check_added_monitors!(nodes[2], 1);
2804         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2805         assert!(updates.update_add_htlcs.is_empty());
2806         assert!(updates.update_fulfill_htlcs.is_empty());
2807         assert!(updates.update_fail_malformed_htlcs.is_empty());
2808         assert_eq!(updates.update_fail_htlcs.len(), 1);
2809         assert!(updates.update_fee.is_none());
2810         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2811         // At this point first_payment_hash has dropped out of the latest two commitment
2812         // transactions that nodes[1] is tracking...
2813         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2814         check_added_monitors!(nodes[1], 1);
2815         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2816         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2817         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2818         check_added_monitors!(nodes[2], 1);
2819
2820         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2821         // on nodes[2]'s RAA.
2822         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2823         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2824         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
2825         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2826         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2827         check_added_monitors!(nodes[1], 0);
2828
2829         if deliver_bs_raa {
2830                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2831                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2832                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2833                 check_added_monitors!(nodes[1], 1);
2834                 let events = nodes[1].node.get_and_clear_pending_events();
2835                 assert_eq!(events.len(), 1);
2836                 match events[0] {
2837                         Event::PendingHTLCsForwardable { .. } => { },
2838                         _ => panic!("Unexpected event"),
2839                 };
2840                 // Deliberately don't process the pending fail-back so they all fail back at once after
2841                 // block connection just like the !deliver_bs_raa case
2842         }
2843
2844         let mut failed_htlcs = HashSet::new();
2845         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2846
2847         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2848         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2849         check_added_monitors!(nodes[1], 1);
2850         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2851
2852         let events = nodes[1].node.get_and_clear_pending_events();
2853         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2854         match events[0] {
2855                 Event::PaymentFailed { ref payment_hash, .. } => {
2856                         assert_eq!(*payment_hash, fourth_payment_hash);
2857                 },
2858                 _ => panic!("Unexpected event"),
2859         }
2860         if !deliver_bs_raa {
2861                 match events[1] {
2862                         Event::PendingHTLCsForwardable { .. } => { },
2863                         _ => panic!("Unexpected event"),
2864                 };
2865         }
2866         nodes[1].node.process_pending_htlc_forwards();
2867         check_added_monitors!(nodes[1], 1);
2868
2869         let events = nodes[1].node.get_and_clear_pending_msg_events();
2870         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2871         match events[if deliver_bs_raa { 1 } else { 0 }] {
2872                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2873                 _ => panic!("Unexpected event"),
2874         }
2875         if deliver_bs_raa {
2876                 match events[0] {
2877                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
2878                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2879                                 assert_eq!(update_add_htlcs.len(), 1);
2880                                 assert!(update_fulfill_htlcs.is_empty());
2881                                 assert!(update_fail_htlcs.is_empty());
2882                                 assert!(update_fail_malformed_htlcs.is_empty());
2883                         },
2884                         _ => panic!("Unexpected event"),
2885                 }
2886         }
2887         match events[if deliver_bs_raa { 2 } else { 1 }] {
2888                 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, .. } } => {
2889                         assert!(update_add_htlcs.is_empty());
2890                         assert_eq!(update_fail_htlcs.len(), 3);
2891                         assert!(update_fulfill_htlcs.is_empty());
2892                         assert!(update_fail_malformed_htlcs.is_empty());
2893                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2894
2895                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2896                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2897                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2898
2899                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2900
2901                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2902                         // If we delivered B's RAA we got an unknown preimage error, not something
2903                         // that we should update our routing table for.
2904                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2905                         for event in events {
2906                                 match event {
2907                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2908                                         _ => panic!("Unexpected event"),
2909                                 }
2910                         }
2911                         let events = nodes[0].node.get_and_clear_pending_events();
2912                         assert_eq!(events.len(), 3);
2913                         match events[0] {
2914                                 Event::PaymentFailed { ref payment_hash, .. } => {
2915                                         assert!(failed_htlcs.insert(payment_hash.0));
2916                                 },
2917                                 _ => panic!("Unexpected event"),
2918                         }
2919                         match events[1] {
2920                                 Event::PaymentFailed { ref payment_hash, .. } => {
2921                                         assert!(failed_htlcs.insert(payment_hash.0));
2922                                 },
2923                                 _ => panic!("Unexpected event"),
2924                         }
2925                         match events[2] {
2926                                 Event::PaymentFailed { ref payment_hash, .. } => {
2927                                         assert!(failed_htlcs.insert(payment_hash.0));
2928                                 },
2929                                 _ => panic!("Unexpected event"),
2930                         }
2931                 },
2932                 _ => panic!("Unexpected event"),
2933         }
2934
2935         assert!(failed_htlcs.contains(&first_payment_hash.0));
2936         assert!(failed_htlcs.contains(&second_payment_hash.0));
2937         assert!(failed_htlcs.contains(&third_payment_hash.0));
2938 }
2939
2940 #[test]
2941 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2942         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2943         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2944         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2945         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2946 }
2947
2948 #[test]
2949 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2950         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2951         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2952         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2953         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2954 }
2955
2956 #[test]
2957 fn fail_backward_pending_htlc_upon_channel_failure() {
2958         let chanmon_cfgs = create_chanmon_cfgs(2);
2959         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2960         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2961         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2962         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::supported(), InitFeatures::supported());
2963
2964         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
2965         {
2966                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
2967                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
2968                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
2969                 check_added_monitors!(nodes[0], 1);
2970
2971                 let payment_event = {
2972                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2973                         assert_eq!(events.len(), 1);
2974                         SendEvent::from_event(events.remove(0))
2975                 };
2976                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
2977                 assert_eq!(payment_event.msgs.len(), 1);
2978         }
2979
2980         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
2981         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2982         {
2983                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
2984                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
2985                 check_added_monitors!(nodes[0], 0);
2986
2987                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2988         }
2989
2990         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
2991         {
2992                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
2993                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
2994
2995                 let secp_ctx = Secp256k1::new();
2996                 let session_priv = {
2997                         let mut session_key = [0; 32];
2998                         let mut rng = thread_rng();
2999                         rng.fill_bytes(&mut session_key);
3000                         SecretKey::from_slice(&session_key).expect("RNG is bad!")
3001                 };
3002
3003                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3004                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3005                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3006                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3007
3008                 // Send a 0-msat update_add_htlc to fail the channel.
3009                 let update_add_htlc = msgs::UpdateAddHTLC {
3010                         channel_id: chan.2,
3011                         htlc_id: 0,
3012                         amount_msat: 0,
3013                         payment_hash,
3014                         cltv_expiry,
3015                         onion_routing_packet,
3016                 };
3017                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3018         }
3019
3020         // Check that Alice fails backward the pending HTLC from the second payment.
3021         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3022         check_closed_broadcast!(nodes[0], true);
3023         check_added_monitors!(nodes[0], 1);
3024 }
3025
3026 #[test]
3027 fn test_htlc_ignore_latest_remote_commitment() {
3028         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3029         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3030         let chanmon_cfgs = create_chanmon_cfgs(2);
3031         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3032         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3033         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3034         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3035
3036         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3037         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3038         check_closed_broadcast!(nodes[0], false);
3039         check_added_monitors!(nodes[0], 1);
3040
3041         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3042         assert_eq!(node_txn.len(), 2);
3043
3044         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3045         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3046         check_closed_broadcast!(nodes[1], false);
3047         check_added_monitors!(nodes[1], 1);
3048
3049         // Duplicate the block_connected call since this may happen due to other listeners
3050         // registering new transactions
3051         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3052 }
3053
3054 #[test]
3055 fn test_force_close_fail_back() {
3056         // Check which HTLCs are failed-backwards on channel force-closure
3057         let chanmon_cfgs = create_chanmon_cfgs(3);
3058         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3059         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3060         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3061         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3062         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3063
3064         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
3065
3066         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3067
3068         let mut payment_event = {
3069                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3070                 check_added_monitors!(nodes[0], 1);
3071
3072                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3073                 assert_eq!(events.len(), 1);
3074                 SendEvent::from_event(events.remove(0))
3075         };
3076
3077         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3078         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3079
3080         expect_pending_htlcs_forwardable!(nodes[1]);
3081
3082         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3083         assert_eq!(events_2.len(), 1);
3084         payment_event = SendEvent::from_event(events_2.remove(0));
3085         assert_eq!(payment_event.msgs.len(), 1);
3086
3087         check_added_monitors!(nodes[1], 1);
3088         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3089         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3090         check_added_monitors!(nodes[2], 1);
3091         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3092
3093         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3094         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3095         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3096
3097         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3098         check_closed_broadcast!(nodes[2], false);
3099         check_added_monitors!(nodes[2], 1);
3100         let tx = {
3101                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3102                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3103                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3104                 // back to nodes[1] upon timeout otherwise.
3105                 assert_eq!(node_txn.len(), 1);
3106                 node_txn.remove(0)
3107         };
3108
3109         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3110         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3111
3112         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3113         check_closed_broadcast!(nodes[1], false);
3114         check_added_monitors!(nodes[1], 1);
3115
3116         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3117         {
3118                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3119                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
3120                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3121         }
3122         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3123         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3124         assert_eq!(node_txn.len(), 1);
3125         assert_eq!(node_txn[0].input.len(), 1);
3126         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3127         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3128         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3129
3130         check_spends!(node_txn[0], tx);
3131 }
3132
3133 #[test]
3134 fn test_unconf_chan() {
3135         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3136         let chanmon_cfgs = create_chanmon_cfgs(2);
3137         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3138         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3139         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3140         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3141
3142         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3143         assert_eq!(channel_state.by_id.len(), 1);
3144         assert_eq!(channel_state.short_to_id.len(), 1);
3145         mem::drop(channel_state);
3146
3147         let mut headers = Vec::new();
3148         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3149         headers.push(header.clone());
3150         for _i in 2..100 {
3151                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3152                 headers.push(header.clone());
3153         }
3154         let mut height = 99;
3155         while !headers.is_empty() {
3156                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3157                 height -= 1;
3158         }
3159         check_closed_broadcast!(nodes[0], false);
3160         check_added_monitors!(nodes[0], 1);
3161         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3162         assert_eq!(channel_state.by_id.len(), 0);
3163         assert_eq!(channel_state.short_to_id.len(), 0);
3164 }
3165
3166 #[test]
3167 fn test_simple_peer_disconnect() {
3168         // Test that we can reconnect when there are no lost messages
3169         let chanmon_cfgs = create_chanmon_cfgs(3);
3170         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3171         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3172         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3173         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3174         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3175
3176         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3177         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3178         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3179
3180         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3181         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3182         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3183         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3184
3185         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3186         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3187         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3188
3189         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3190         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3191         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3192         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3193
3194         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3195         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3196
3197         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3198         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3199
3200         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3201         {
3202                 let events = nodes[0].node.get_and_clear_pending_events();
3203                 assert_eq!(events.len(), 2);
3204                 match events[0] {
3205                         Event::PaymentSent { payment_preimage } => {
3206                                 assert_eq!(payment_preimage, payment_preimage_3);
3207                         },
3208                         _ => panic!("Unexpected event"),
3209                 }
3210                 match events[1] {
3211                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3212                                 assert_eq!(payment_hash, payment_hash_5);
3213                                 assert!(rejected_by_dest);
3214                         },
3215                         _ => panic!("Unexpected event"),
3216                 }
3217         }
3218
3219         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3220         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3221 }
3222
3223 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3224         // Test that we can reconnect when in-flight HTLC updates get dropped
3225         let chanmon_cfgs = create_chanmon_cfgs(2);
3226         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3227         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3228         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3229         if messages_delivered == 0 {
3230                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3231                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3232         } else {
3233                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3234         }
3235
3236         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3237         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3238
3239         let payment_event = {
3240                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3241                 check_added_monitors!(nodes[0], 1);
3242
3243                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3244                 assert_eq!(events.len(), 1);
3245                 SendEvent::from_event(events.remove(0))
3246         };
3247         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3248
3249         if messages_delivered < 2 {
3250                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3251         } else {
3252                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3253                 if messages_delivered >= 3 {
3254                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3255                         check_added_monitors!(nodes[1], 1);
3256                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3257
3258                         if messages_delivered >= 4 {
3259                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3260                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3261                                 check_added_monitors!(nodes[0], 1);
3262
3263                                 if messages_delivered >= 5 {
3264                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3265                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3266                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3267                                         check_added_monitors!(nodes[0], 1);
3268
3269                                         if messages_delivered >= 6 {
3270                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3271                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3272                                                 check_added_monitors!(nodes[1], 1);
3273                                         }
3274                                 }
3275                         }
3276                 }
3277         }
3278
3279         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3280         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3281         if messages_delivered < 3 {
3282                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3283                 // received on either side, both sides will need to resend them.
3284                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3285         } else if messages_delivered == 3 {
3286                 // nodes[0] still wants its RAA + commitment_signed
3287                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3288         } else if messages_delivered == 4 {
3289                 // nodes[0] still wants its commitment_signed
3290                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3291         } else if messages_delivered == 5 {
3292                 // nodes[1] still wants its final RAA
3293                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3294         } else if messages_delivered == 6 {
3295                 // Everything was delivered...
3296                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3297         }
3298
3299         let events_1 = nodes[1].node.get_and_clear_pending_events();
3300         assert_eq!(events_1.len(), 1);
3301         match events_1[0] {
3302                 Event::PendingHTLCsForwardable { .. } => { },
3303                 _ => panic!("Unexpected event"),
3304         };
3305
3306         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3307         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3308         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3309
3310         nodes[1].node.process_pending_htlc_forwards();
3311
3312         let events_2 = nodes[1].node.get_and_clear_pending_events();
3313         assert_eq!(events_2.len(), 1);
3314         match events_2[0] {
3315                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3316                         assert_eq!(payment_hash_1, *payment_hash);
3317                         assert_eq!(*payment_secret, None);
3318                         assert_eq!(amt, 1000000);
3319                 },
3320                 _ => panic!("Unexpected event"),
3321         }
3322
3323         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3324         check_added_monitors!(nodes[1], 1);
3325
3326         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3327         assert_eq!(events_3.len(), 1);
3328         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3329                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3330                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3331                         assert!(updates.update_add_htlcs.is_empty());
3332                         assert!(updates.update_fail_htlcs.is_empty());
3333                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3334                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3335                         assert!(updates.update_fee.is_none());
3336                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3337                 },
3338                 _ => panic!("Unexpected event"),
3339         };
3340
3341         if messages_delivered >= 1 {
3342                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3343
3344                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3345                 assert_eq!(events_4.len(), 1);
3346                 match events_4[0] {
3347                         Event::PaymentSent { ref payment_preimage } => {
3348                                 assert_eq!(payment_preimage_1, *payment_preimage);
3349                         },
3350                         _ => panic!("Unexpected event"),
3351                 }
3352
3353                 if messages_delivered >= 2 {
3354                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3355                         check_added_monitors!(nodes[0], 1);
3356                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3357
3358                         if messages_delivered >= 3 {
3359                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3360                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3361                                 check_added_monitors!(nodes[1], 1);
3362
3363                                 if messages_delivered >= 4 {
3364                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3365                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3366                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3367                                         check_added_monitors!(nodes[1], 1);
3368
3369                                         if messages_delivered >= 5 {
3370                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3371                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3372                                                 check_added_monitors!(nodes[0], 1);
3373                                         }
3374                                 }
3375                         }
3376                 }
3377         }
3378
3379         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3380         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3381         if messages_delivered < 2 {
3382                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3383                 //TODO: Deduplicate PaymentSent events, then enable this if:
3384                 //if messages_delivered < 1 {
3385                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3386                         assert_eq!(events_4.len(), 1);
3387                         match events_4[0] {
3388                                 Event::PaymentSent { ref payment_preimage } => {
3389                                         assert_eq!(payment_preimage_1, *payment_preimage);
3390                                 },
3391                                 _ => panic!("Unexpected event"),
3392                         }
3393                 //}
3394         } else if messages_delivered == 2 {
3395                 // nodes[0] still wants its RAA + commitment_signed
3396                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3397         } else if messages_delivered == 3 {
3398                 // nodes[0] still wants its commitment_signed
3399                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3400         } else if messages_delivered == 4 {
3401                 // nodes[1] still wants its final RAA
3402                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3403         } else if messages_delivered == 5 {
3404                 // Everything was delivered...
3405                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3406         }
3407
3408         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3409         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3410         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3411
3412         // Channel should still work fine...
3413         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3414         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3415 }
3416
3417 #[test]
3418 fn test_drop_messages_peer_disconnect_a() {
3419         do_test_drop_messages_peer_disconnect(0);
3420         do_test_drop_messages_peer_disconnect(1);
3421         do_test_drop_messages_peer_disconnect(2);
3422         do_test_drop_messages_peer_disconnect(3);
3423 }
3424
3425 #[test]
3426 fn test_drop_messages_peer_disconnect_b() {
3427         do_test_drop_messages_peer_disconnect(4);
3428         do_test_drop_messages_peer_disconnect(5);
3429         do_test_drop_messages_peer_disconnect(6);
3430 }
3431
3432 #[test]
3433 fn test_funding_peer_disconnect() {
3434         // Test that we can lock in our funding tx while disconnected
3435         let chanmon_cfgs = create_chanmon_cfgs(2);
3436         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3437         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3438         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3439         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3440
3441         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3442         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3443
3444         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3445         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3446         assert_eq!(events_1.len(), 1);
3447         match events_1[0] {
3448                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3449                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3450                 },
3451                 _ => panic!("Unexpected event"),
3452         }
3453
3454         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3455
3456         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3457         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3458
3459         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3460         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3461         assert_eq!(events_2.len(), 2);
3462         let funding_locked = match events_2[0] {
3463                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3464                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3465                         msg.clone()
3466                 },
3467                 _ => panic!("Unexpected event"),
3468         };
3469         let bs_announcement_sigs = match events_2[1] {
3470                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3471                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3472                         msg.clone()
3473                 },
3474                 _ => panic!("Unexpected event"),
3475         };
3476
3477         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3478
3479         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3480         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3481         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3482         assert_eq!(events_3.len(), 2);
3483         let as_announcement_sigs = match events_3[0] {
3484                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3485                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3486                         msg.clone()
3487                 },
3488                 _ => panic!("Unexpected event"),
3489         };
3490         let (as_announcement, as_update) = match events_3[1] {
3491                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3492                         (msg.clone(), update_msg.clone())
3493                 },
3494                 _ => panic!("Unexpected event"),
3495         };
3496
3497         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3498         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3499         assert_eq!(events_4.len(), 1);
3500         let (_, bs_update) = match events_4[0] {
3501                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3502                         (msg.clone(), update_msg.clone())
3503                 },
3504                 _ => panic!("Unexpected event"),
3505         };
3506
3507         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3508         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3509         nodes[0].router.handle_channel_update(&as_update).unwrap();
3510
3511         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3512         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3513         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3514 }
3515
3516 #[test]
3517 fn test_drop_messages_peer_disconnect_dual_htlc() {
3518         // Test that we can handle reconnecting when both sides of a channel have pending
3519         // commitment_updates when we disconnect.
3520         let chanmon_cfgs = create_chanmon_cfgs(2);
3521         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3522         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3523         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3524         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3525
3526         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3527
3528         // Now try to send a second payment which will fail to send
3529         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3530         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3531
3532         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3533         check_added_monitors!(nodes[0], 1);
3534
3535         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3536         assert_eq!(events_1.len(), 1);
3537         match events_1[0] {
3538                 MessageSendEvent::UpdateHTLCs { .. } => {},
3539                 _ => panic!("Unexpected event"),
3540         }
3541
3542         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3543         check_added_monitors!(nodes[1], 1);
3544
3545         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3546         assert_eq!(events_2.len(), 1);
3547         match events_2[0] {
3548                 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 } } => {
3549                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3550                         assert!(update_add_htlcs.is_empty());
3551                         assert_eq!(update_fulfill_htlcs.len(), 1);
3552                         assert!(update_fail_htlcs.is_empty());
3553                         assert!(update_fail_malformed_htlcs.is_empty());
3554                         assert!(update_fee.is_none());
3555
3556                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3557                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3558                         assert_eq!(events_3.len(), 1);
3559                         match events_3[0] {
3560                                 Event::PaymentSent { ref payment_preimage } => {
3561                                         assert_eq!(*payment_preimage, payment_preimage_1);
3562                                 },
3563                                 _ => panic!("Unexpected event"),
3564                         }
3565
3566                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3567                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3568                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3569                         check_added_monitors!(nodes[0], 1);
3570                 },
3571                 _ => panic!("Unexpected event"),
3572         }
3573
3574         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3575         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3576
3577         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3578         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3579         assert_eq!(reestablish_1.len(), 1);
3580         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3581         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3582         assert_eq!(reestablish_2.len(), 1);
3583
3584         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3585         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3586         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3587         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3588
3589         assert!(as_resp.0.is_none());
3590         assert!(bs_resp.0.is_none());
3591
3592         assert!(bs_resp.1.is_none());
3593         assert!(bs_resp.2.is_none());
3594
3595         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3596
3597         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3598         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3599         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3600         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3601         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3602         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3603         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3604         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3605         // No commitment_signed so get_event_msg's assert(len == 1) passes
3606         check_added_monitors!(nodes[1], 1);
3607
3608         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3609         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3610         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3611         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3612         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3613         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3614         assert!(bs_second_commitment_signed.update_fee.is_none());
3615         check_added_monitors!(nodes[1], 1);
3616
3617         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3618         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3619         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3620         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3621         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3622         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3623         assert!(as_commitment_signed.update_fee.is_none());
3624         check_added_monitors!(nodes[0], 1);
3625
3626         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3627         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3628         // No commitment_signed so get_event_msg's assert(len == 1) passes
3629         check_added_monitors!(nodes[0], 1);
3630
3631         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3632         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3633         // No commitment_signed so get_event_msg's assert(len == 1) passes
3634         check_added_monitors!(nodes[1], 1);
3635
3636         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3637         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3638         check_added_monitors!(nodes[1], 1);
3639
3640         expect_pending_htlcs_forwardable!(nodes[1]);
3641
3642         let events_5 = nodes[1].node.get_and_clear_pending_events();
3643         assert_eq!(events_5.len(), 1);
3644         match events_5[0] {
3645                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3646                         assert_eq!(payment_hash_2, *payment_hash);
3647                         assert_eq!(*payment_secret, None);
3648                 },
3649                 _ => panic!("Unexpected event"),
3650         }
3651
3652         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_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         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3657 }
3658
3659 #[test]
3660 fn test_invalid_channel_announcement() {
3661         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3662         let secp_ctx = Secp256k1::new();
3663         let chanmon_cfgs = create_chanmon_cfgs(2);
3664         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3665         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3666         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3667
3668         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3669
3670         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3671         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3672         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3673         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3674
3675         nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3676
3677         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3678         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3679
3680         let as_network_key = nodes[0].node.get_our_node_id();
3681         let bs_network_key = nodes[1].node.get_our_node_id();
3682
3683         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3684
3685         let mut chan_announcement;
3686
3687         macro_rules! dummy_unsigned_msg {
3688                 () => {
3689                         msgs::UnsignedChannelAnnouncement {
3690                                 features: ChannelFeatures::supported(),
3691                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3692                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3693                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3694                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3695                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3696                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3697                                 excess_data: Vec::new(),
3698                         };
3699                 }
3700         }
3701
3702         macro_rules! sign_msg {
3703                 ($unsigned_msg: expr) => {
3704                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3705                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key());
3706                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key());
3707                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3708                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3709                         chan_announcement = msgs::ChannelAnnouncement {
3710                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3711                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3712                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3713                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3714                                 contents: $unsigned_msg
3715                         }
3716                 }
3717         }
3718
3719         let unsigned_msg = dummy_unsigned_msg!();
3720         sign_msg!(unsigned_msg);
3721         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3722         let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3723
3724         // Configured with Network::Testnet
3725         let mut unsigned_msg = dummy_unsigned_msg!();
3726         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3727         sign_msg!(unsigned_msg);
3728         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3729
3730         let mut unsigned_msg = dummy_unsigned_msg!();
3731         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3732         sign_msg!(unsigned_msg);
3733         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3734 }
3735
3736 #[test]
3737 fn test_no_txn_manager_serialize_deserialize() {
3738         let chanmon_cfgs = create_chanmon_cfgs(2);
3739         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3740         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3741         let fee_estimator: test_utils::TestFeeEstimator;
3742         let new_chan_monitor: test_utils::TestChannelMonitor;
3743         let keys_manager: test_utils::TestKeysInterface;
3744         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3745         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3746
3747         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3748
3749         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3750
3751         let nodes_0_serialized = nodes[0].node.encode();
3752         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3753         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3754
3755         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3756         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), &fee_estimator);
3757         nodes[0].chan_monitor = &new_chan_monitor;
3758         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3759         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3760         assert!(chan_0_monitor_read.is_empty());
3761
3762         let mut nodes_0_read = &nodes_0_serialized[..];
3763         let config = UserConfig::default();
3764         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3765         let (_, nodes_0_deserialized_tmp) = {
3766                 let mut channel_monitors = HashMap::new();
3767                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3768                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3769                         default_config: config,
3770                         keys_manager: &keys_manager,
3771                         fee_estimator: &fee_estimator,
3772                         monitor: nodes[0].chan_monitor,
3773                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3774                         logger: Arc::new(test_utils::TestLogger::new()),
3775                         channel_monitors: &mut channel_monitors,
3776                 }).unwrap()
3777         };
3778         nodes_0_deserialized = nodes_0_deserialized_tmp;
3779         assert!(nodes_0_read.is_empty());
3780
3781         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3782         nodes[0].node = &nodes_0_deserialized;
3783         nodes[0].block_notifier.register_listener(nodes[0].node);
3784         assert_eq!(nodes[0].node.list_channels().len(), 1);
3785         check_added_monitors!(nodes[0], 1);
3786
3787         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3788         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3789         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3790         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3791
3792         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3793         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3794         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3795         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3796
3797         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3798         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3799         for node in nodes.iter() {
3800                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3801                 node.router.handle_channel_update(&as_update).unwrap();
3802                 node.router.handle_channel_update(&bs_update).unwrap();
3803         }
3804
3805         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3806 }
3807
3808 #[test]
3809 fn test_simple_manager_serialize_deserialize() {
3810         let chanmon_cfgs = create_chanmon_cfgs(2);
3811         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3812         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3813         let fee_estimator: test_utils::TestFeeEstimator;
3814         let new_chan_monitor: test_utils::TestChannelMonitor;
3815         let keys_manager: test_utils::TestKeysInterface;
3816         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3817         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3818         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3819
3820         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3821         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3822
3823         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3824
3825         let nodes_0_serialized = nodes[0].node.encode();
3826         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3827         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3828
3829         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3830         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), &fee_estimator);
3831         nodes[0].chan_monitor = &new_chan_monitor;
3832         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3833         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3834         assert!(chan_0_monitor_read.is_empty());
3835
3836         let mut nodes_0_read = &nodes_0_serialized[..];
3837         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3838         let (_, nodes_0_deserialized_tmp) = {
3839                 let mut channel_monitors = HashMap::new();
3840                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3841                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3842                         default_config: UserConfig::default(),
3843                         keys_manager: &keys_manager,
3844                         fee_estimator: &fee_estimator,
3845                         monitor: nodes[0].chan_monitor,
3846                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3847                         logger: Arc::new(test_utils::TestLogger::new()),
3848                         channel_monitors: &mut channel_monitors,
3849                 }).unwrap()
3850         };
3851         nodes_0_deserialized = nodes_0_deserialized_tmp;
3852         assert!(nodes_0_read.is_empty());
3853
3854         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3855         nodes[0].node = &nodes_0_deserialized;
3856         check_added_monitors!(nodes[0], 1);
3857
3858         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3859
3860         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3861         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3862 }
3863
3864 #[test]
3865 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3866         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3867         let chanmon_cfgs = create_chanmon_cfgs(4);
3868         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3869         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3870         let fee_estimator: test_utils::TestFeeEstimator;
3871         let new_chan_monitor: test_utils::TestChannelMonitor;
3872         let keys_manager: test_utils::TestKeysInterface;
3873         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3874         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3875         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3876         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3877         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3878
3879         let mut node_0_stale_monitors_serialized = Vec::new();
3880         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3881                 let mut writer = test_utils::TestVecWriter(Vec::new());
3882                 monitor.1.write_for_disk(&mut writer).unwrap();
3883                 node_0_stale_monitors_serialized.push(writer.0);
3884         }
3885
3886         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3887
3888         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3889         let nodes_0_serialized = nodes[0].node.encode();
3890
3891         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3892         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3893         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3894         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3895
3896         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3897         // nodes[3])
3898         let mut node_0_monitors_serialized = Vec::new();
3899         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3900                 let mut writer = test_utils::TestVecWriter(Vec::new());
3901                 monitor.1.write_for_disk(&mut writer).unwrap();
3902                 node_0_monitors_serialized.push(writer.0);
3903         }
3904
3905         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3906         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), &fee_estimator);
3907         nodes[0].chan_monitor = &new_chan_monitor;
3908
3909         let mut node_0_stale_monitors = Vec::new();
3910         for serialized in node_0_stale_monitors_serialized.iter() {
3911                 let mut read = &serialized[..];
3912                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3913                 assert!(read.is_empty());
3914                 node_0_stale_monitors.push(monitor);
3915         }
3916
3917         let mut node_0_monitors = Vec::new();
3918         for serialized in node_0_monitors_serialized.iter() {
3919                 let mut read = &serialized[..];
3920                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3921                 assert!(read.is_empty());
3922                 node_0_monitors.push(monitor);
3923         }
3924
3925         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3926
3927         let mut nodes_0_read = &nodes_0_serialized[..];
3928         if let Err(msgs::DecodeError::InvalidValue) =
3929                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3930                 default_config: UserConfig::default(),
3931                 keys_manager: &keys_manager,
3932                 fee_estimator: &fee_estimator,
3933                 monitor: nodes[0].chan_monitor,
3934                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3935                 logger: Arc::new(test_utils::TestLogger::new()),
3936                 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3937         }) { } else {
3938                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
3939         };
3940
3941         let mut nodes_0_read = &nodes_0_serialized[..];
3942         let (_, nodes_0_deserialized_tmp) =
3943                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3944                 default_config: UserConfig::default(),
3945                 keys_manager: &keys_manager,
3946                 fee_estimator: &fee_estimator,
3947                 monitor: nodes[0].chan_monitor,
3948                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3949                 logger: Arc::new(test_utils::TestLogger::new()),
3950                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3951         }).unwrap();
3952         nodes_0_deserialized = nodes_0_deserialized_tmp;
3953         assert!(nodes_0_read.is_empty());
3954
3955         { // Channel close should result in a commitment tx and an HTLC tx
3956                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3957                 assert_eq!(txn.len(), 2);
3958                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3959                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3960         }
3961
3962         for monitor in node_0_monitors.drain(..) {
3963                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3964                 check_added_monitors!(nodes[0], 1);
3965         }
3966         nodes[0].node = &nodes_0_deserialized;
3967
3968         // nodes[1] and nodes[2] have no lost state with nodes[0]...
3969         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3970         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3971         //... and we can even still claim the payment!
3972         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3973
3974         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3975         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3976         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3977         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3978         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3979         assert_eq!(msg_events.len(), 1);
3980         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3981                 match action {
3982                         &ErrorAction::SendErrorMessage { ref msg } => {
3983                                 assert_eq!(msg.channel_id, channel_id);
3984                         },
3985                         _ => panic!("Unexpected event!"),
3986                 }
3987         }
3988 }
3989
3990 macro_rules! check_spendable_outputs {
3991         ($node: expr, $der_idx: expr) => {
3992                 {
3993                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3994                         let mut txn = Vec::new();
3995                         for event in events {
3996                                 match event {
3997                                         Event::SpendableOutputs { ref outputs } => {
3998                                                 for outp in outputs {
3999                                                         match *outp {
4000                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
4001                                                                         let input = TxIn {
4002                                                                                 previous_output: outpoint.clone(),
4003                                                                                 script_sig: Script::new(),
4004                                                                                 sequence: 0,
4005                                                                                 witness: Vec::new(),
4006                                                                         };
4007                                                                         let outp = TxOut {
4008                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4009                                                                                 value: output.value,
4010                                                                         };
4011                                                                         let mut spend_tx = Transaction {
4012                                                                                 version: 2,
4013                                                                                 lock_time: 0,
4014                                                                                 input: vec![input],
4015                                                                                 output: vec![outp],
4016                                                                         };
4017                                                                         let secp_ctx = Secp256k1::new();
4018                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
4019                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4020                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4021                                                                         let remotesig = secp_ctx.sign(&sighash, key);
4022                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4023                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4024                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4025                                                                         txn.push(spend_tx);
4026                                                                 },
4027                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
4028                                                                         let input = TxIn {
4029                                                                                 previous_output: outpoint.clone(),
4030                                                                                 script_sig: Script::new(),
4031                                                                                 sequence: *to_self_delay as u32,
4032                                                                                 witness: Vec::new(),
4033                                                                         };
4034                                                                         let outp = TxOut {
4035                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4036                                                                                 value: output.value,
4037                                                                         };
4038                                                                         let mut spend_tx = Transaction {
4039                                                                                 version: 2,
4040                                                                                 lock_time: 0,
4041                                                                                 input: vec![input],
4042                                                                                 output: vec![outp],
4043                                                                         };
4044                                                                         let secp_ctx = Secp256k1::new();
4045                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
4046                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
4047                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
4048                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4049                                                                         spend_tx.input[0].witness.push(vec!());
4050                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4051                                                                         txn.push(spend_tx);
4052                                                                 },
4053                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4054                                                                         let secp_ctx = Secp256k1::new();
4055                                                                         let input = TxIn {
4056                                                                                 previous_output: outpoint.clone(),
4057                                                                                 script_sig: Script::new(),
4058                                                                                 sequence: 0,
4059                                                                                 witness: Vec::new(),
4060                                                                         };
4061                                                                         let outp = TxOut {
4062                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4063                                                                                 value: output.value,
4064                                                                         };
4065                                                                         let mut spend_tx = Transaction {
4066                                                                                 version: 2,
4067                                                                                 lock_time: 0,
4068                                                                                 input: vec![input],
4069                                                                                 output: vec![outp.clone()],
4070                                                                         };
4071                                                                         let secret = {
4072                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4073                                                                                         Ok(master_key) => {
4074                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4075                                                                                                         Ok(key) => key,
4076                                                                                                         Err(_) => panic!("Your RNG is busted"),
4077                                                                                                 }
4078                                                                                         }
4079                                                                                         Err(_) => panic!("Your rng is busted"),
4080                                                                                 }
4081                                                                         };
4082                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4083                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4084                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4085                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4086                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4087                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4088                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4089                                                                         txn.push(spend_tx);
4090                                                                 },
4091                                                         }
4092                                                 }
4093                                         },
4094                                         _ => panic!("Unexpected event"),
4095                                 };
4096                         }
4097                         txn
4098                 }
4099         }
4100 }
4101
4102 #[test]
4103 fn test_claim_sizeable_push_msat() {
4104         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4105         let chanmon_cfgs = create_chanmon_cfgs(2);
4106         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4107         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4108         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4109
4110         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4111         nodes[1].node.force_close_channel(&chan.2);
4112         check_closed_broadcast!(nodes[1], false);
4113         check_added_monitors!(nodes[1], 1);
4114         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4115         assert_eq!(node_txn.len(), 1);
4116         check_spends!(node_txn[0], chan.3);
4117         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
4118
4119         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4120         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4121         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4122
4123         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4124         assert_eq!(spend_txn.len(), 1);
4125         check_spends!(spend_txn[0], node_txn[0]);
4126 }
4127
4128 #[test]
4129 fn test_claim_on_remote_sizeable_push_msat() {
4130         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4131         // to_remote output is encumbered by a P2WPKH
4132         let chanmon_cfgs = create_chanmon_cfgs(2);
4133         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4134         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4135         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4136
4137         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4138         nodes[0].node.force_close_channel(&chan.2);
4139         check_closed_broadcast!(nodes[0], false);
4140         check_added_monitors!(nodes[0], 1);
4141
4142         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4143         assert_eq!(node_txn.len(), 1);
4144         check_spends!(node_txn[0], chan.3);
4145         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
4146
4147         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4148         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4149         check_closed_broadcast!(nodes[1], false);
4150         check_added_monitors!(nodes[1], 1);
4151         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4152
4153         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4154         assert_eq!(spend_txn.len(), 2);
4155         assert_eq!(spend_txn[0], spend_txn[1]);
4156         check_spends!(spend_txn[0], node_txn[0]);
4157 }
4158
4159 #[test]
4160 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4161         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4162         // to_remote output is encumbered by a P2WPKH
4163
4164         let chanmon_cfgs = create_chanmon_cfgs(2);
4165         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4166         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4167         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4168
4169         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
4170         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4171         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4172         assert_eq!(revoked_local_txn[0].input.len(), 1);
4173         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4174
4175         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4176         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4177         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4178         check_closed_broadcast!(nodes[1], false);
4179         check_added_monitors!(nodes[1], 1);
4180
4181         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4182         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4183         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4184         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4185
4186         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4187         assert_eq!(spend_txn.len(), 3);
4188         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4189         check_spends!(spend_txn[0], revoked_local_txn[0]);
4190         check_spends!(spend_txn[2], node_txn[0]);
4191 }
4192
4193 #[test]
4194 fn test_static_spendable_outputs_preimage_tx() {
4195         let chanmon_cfgs = create_chanmon_cfgs(2);
4196         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4197         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4198         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4199
4200         // Create some initial channels
4201         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4202
4203         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4204
4205         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4206         assert_eq!(commitment_tx[0].input.len(), 1);
4207         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4208
4209         // Settle A's commitment tx on B's chain
4210         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4211         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4212         check_added_monitors!(nodes[1], 1);
4213         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4214         check_added_monitors!(nodes[1], 1);
4215         let events = nodes[1].node.get_and_clear_pending_msg_events();
4216         match events[0] {
4217                 MessageSendEvent::UpdateHTLCs { .. } => {},
4218                 _ => panic!("Unexpected event"),
4219         }
4220         match events[1] {
4221                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4222                 _ => panic!("Unexepected event"),
4223         }
4224
4225         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4226         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4227         assert_eq!(node_txn.len(), 3);
4228         check_spends!(node_txn[0], commitment_tx[0]);
4229         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4230         check_spends!(node_txn[1], chan_1.3);
4231         check_spends!(node_txn[2], node_txn[1]);
4232
4233         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4234         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4235         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4236
4237         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4238         assert_eq!(spend_txn.len(), 1);
4239         check_spends!(spend_txn[0], node_txn[0]);
4240 }
4241
4242 #[test]
4243 fn test_static_spendable_outputs_timeout_tx() {
4244         let chanmon_cfgs = create_chanmon_cfgs(2);
4245         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4246         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4247         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4248
4249         // Create some initial channels
4250         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4251
4252         // Rebalance the network a bit by relaying one payment through all the channels ...
4253         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4254
4255         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4256
4257         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4258         assert_eq!(commitment_tx[0].input.len(), 1);
4259         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4260
4261         // Settle A's commitment tx on B' chain
4262         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4263         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4264         check_added_monitors!(nodes[1], 1);
4265         let events = nodes[1].node.get_and_clear_pending_msg_events();
4266         match events[0] {
4267                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4268                 _ => panic!("Unexpected event"),
4269         }
4270
4271         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4272         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4273         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4274         check_spends!(node_txn[0],  commitment_tx[0].clone());
4275         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4276         check_spends!(node_txn[1], chan_1.3.clone());
4277         check_spends!(node_txn[2], node_txn[1]);
4278
4279         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4280         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4281         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4282         let events = nodes[1].node.get_and_clear_pending_events();
4283         assert_eq!(events.len(), 1);
4284         match events[0] {
4285                 Event::PaymentFailed { payment_hash, .. } => {
4286                         assert_eq!(payment_hash, our_payment_hash);
4287                 },
4288                 _ => panic!("Unexpected event"),
4289         }
4290
4291         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4292         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4293         check_spends!(spend_txn[2], node_txn[0].clone());
4294 }
4295
4296 #[test]
4297 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4298         let chanmon_cfgs = create_chanmon_cfgs(2);
4299         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4300         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4301         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4302
4303         // Create some initial channels
4304         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4305
4306         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4307         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4308         assert_eq!(revoked_local_txn[0].input.len(), 1);
4309         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4310
4311         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4312
4313         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4314         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4315         check_closed_broadcast!(nodes[1], false);
4316         check_added_monitors!(nodes[1], 1);
4317
4318         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4319         assert_eq!(node_txn.len(), 2);
4320         assert_eq!(node_txn[0].input.len(), 2);
4321         check_spends!(node_txn[0], revoked_local_txn[0]);
4322
4323         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4324         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4325         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4326
4327         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4328         assert_eq!(spend_txn.len(), 1);
4329         check_spends!(spend_txn[0], node_txn[0]);
4330 }
4331
4332 #[test]
4333 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4334         let chanmon_cfgs = create_chanmon_cfgs(2);
4335         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4336         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4337         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4338
4339         // Create some initial channels
4340         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4341
4342         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4343         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4344         assert_eq!(revoked_local_txn[0].input.len(), 1);
4345         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4346
4347         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4348
4349         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4350         // A will generate HTLC-Timeout from revoked commitment tx
4351         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4352         check_closed_broadcast!(nodes[0], false);
4353         check_added_monitors!(nodes[0], 1);
4354
4355         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4356         assert_eq!(revoked_htlc_txn.len(), 2);
4357         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4358         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4359         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4360         check_spends!(revoked_htlc_txn[1], chan_1.3);
4361
4362         // B will generate justice tx from A's revoked commitment/HTLC tx
4363         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
4364         check_closed_broadcast!(nodes[1], false);
4365         check_added_monitors!(nodes[1], 1);
4366
4367         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4368         assert_eq!(node_txn.len(), 4); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-timeout, adjusted justice tx, ChannelManager: local commitment tx
4369         assert_eq!(node_txn[0].input.len(), 2);
4370         check_spends!(node_txn[0], revoked_local_txn[0]);
4371         check_spends!(node_txn[1], chan_1.3);
4372         assert_eq!(node_txn[2].input.len(), 1);
4373         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4374         assert_eq!(node_txn[3].input.len(), 1);
4375         check_spends!(node_txn[3], revoked_local_txn[0]);
4376
4377         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4378         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4379         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4380
4381         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4382         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4383         assert_eq!(spend_txn.len(), 2);
4384         check_spends!(spend_txn[0], node_txn[0]);
4385         check_spends!(spend_txn[1], node_txn[2]);
4386 }
4387
4388 #[test]
4389 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4390         let chanmon_cfgs = create_chanmon_cfgs(2);
4391         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4392         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4393         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4394
4395         // Create some initial channels
4396         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4397
4398         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4399         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4400         assert_eq!(revoked_local_txn[0].input.len(), 1);
4401         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4402
4403         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4404
4405         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4406         // B will generate HTLC-Success from revoked commitment tx
4407         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4408         check_closed_broadcast!(nodes[1], false);
4409         check_added_monitors!(nodes[1], 1);
4410         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4411
4412         assert_eq!(revoked_htlc_txn.len(), 2);
4413         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4414         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4415         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4416
4417         // A will generate justice tx from B's revoked commitment/HTLC tx
4418         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4419         check_closed_broadcast!(nodes[0], false);
4420         check_added_monitors!(nodes[0], 1);
4421
4422         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4423         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4424         assert_eq!(node_txn[2].input.len(), 1);
4425         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4426
4427         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4428         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4429         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4430
4431         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4432         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4433         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
4434         assert_eq!(spend_txn[0], spend_txn[1]);
4435         assert_eq!(spend_txn[0], spend_txn[2]);
4436         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4437         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
4438         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
4439 }
4440
4441 #[test]
4442 fn test_onchain_to_onchain_claim() {
4443         // Test that in case of channel closure, we detect the state of output thanks to
4444         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4445         // First, have C claim an HTLC against its own latest commitment transaction.
4446         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4447         // channel.
4448         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4449         // gets broadcast.
4450
4451         let chanmon_cfgs = create_chanmon_cfgs(3);
4452         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4453         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4454         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4455
4456         // Create some initial channels
4457         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4458         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4459
4460         // Rebalance the network a bit by relaying one payment through all the channels ...
4461         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4462         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4463
4464         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4465         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4466         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4467         check_spends!(commitment_tx[0], chan_2.3);
4468         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
4469         check_added_monitors!(nodes[2], 1);
4470         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4471         assert!(updates.update_add_htlcs.is_empty());
4472         assert!(updates.update_fail_htlcs.is_empty());
4473         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4474         assert!(updates.update_fail_malformed_htlcs.is_empty());
4475
4476         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4477         check_closed_broadcast!(nodes[2], false);
4478         check_added_monitors!(nodes[2], 1);
4479
4480         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4481         assert_eq!(c_txn.len(), 3);
4482         assert_eq!(c_txn[0], c_txn[2]);
4483         assert_eq!(commitment_tx[0], c_txn[1]);
4484         check_spends!(c_txn[1], chan_2.3);
4485         check_spends!(c_txn[2], c_txn[1]);
4486         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4487         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4488         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4489         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4490
4491         // 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
4492         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4493         {
4494                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4495                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4496                 assert_eq!(b_txn.len(), 3);
4497                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4498                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4499                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4500                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4501                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4502                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4503                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4504                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4505                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4506                 b_txn.clear();
4507         }
4508         check_added_monitors!(nodes[1], 1);
4509         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4510         check_added_monitors!(nodes[1], 1);
4511         match msg_events[0] {
4512                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4513                 _ => panic!("Unexpected event"),
4514         }
4515         match msg_events[1] {
4516                 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, .. } } => {
4517                         assert!(update_add_htlcs.is_empty());
4518                         assert!(update_fail_htlcs.is_empty());
4519                         assert_eq!(update_fulfill_htlcs.len(), 1);
4520                         assert!(update_fail_malformed_htlcs.is_empty());
4521                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4522                 },
4523                 _ => panic!("Unexpected event"),
4524         };
4525         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4526         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4527         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4528         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4529         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4530         assert_eq!(b_txn.len(), 3);
4531         check_spends!(b_txn[1], chan_1.3);
4532         check_spends!(b_txn[2], b_txn[1]);
4533         check_spends!(b_txn[0], commitment_tx[0]);
4534         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4535         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4536         assert_eq!(b_txn[0].lock_time, 0); // Success tx
4537
4538         check_closed_broadcast!(nodes[1], false);
4539         check_added_monitors!(nodes[1], 1);
4540 }
4541
4542 #[test]
4543 fn test_duplicate_payment_hash_one_failure_one_success() {
4544         // Topology : A --> B --> C
4545         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4546         let chanmon_cfgs = create_chanmon_cfgs(3);
4547         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4548         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4549         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4550
4551         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4552         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4553
4554         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4555         *nodes[0].network_payment_count.borrow_mut() -= 1;
4556         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4557
4558         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
4559         assert_eq!(commitment_txn[0].input.len(), 1);
4560         check_spends!(commitment_txn[0], chan_2.3);
4561
4562         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4563         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4564         check_closed_broadcast!(nodes[1], false);
4565         check_added_monitors!(nodes[1], 1);
4566
4567         let htlc_timeout_tx;
4568         { // Extract one of the two HTLC-Timeout transaction
4569                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4570                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
4571                 assert_eq!(node_txn.len(), 5);
4572                 check_spends!(node_txn[0], commitment_txn[0]);
4573                 assert_eq!(node_txn[0].input.len(), 1);
4574                 check_spends!(node_txn[1], commitment_txn[0]);
4575                 assert_eq!(node_txn[1].input.len(), 1);
4576                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4577                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4578                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4579                 check_spends!(node_txn[2], chan_2.3);
4580                 check_spends!(node_txn[3], node_txn[2]);
4581                 check_spends!(node_txn[4], node_txn[2]);
4582                 htlc_timeout_tx = node_txn[1].clone();
4583         }
4584
4585         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
4586         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4587         check_added_monitors!(nodes[2], 3);
4588         let events = nodes[2].node.get_and_clear_pending_msg_events();
4589         match events[0] {
4590                 MessageSendEvent::UpdateHTLCs { .. } => {},
4591                 _ => panic!("Unexpected event"),
4592         }
4593         match events[1] {
4594                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4595                 _ => panic!("Unexepected event"),
4596         }
4597         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4598         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)
4599         check_spends!(htlc_success_txn[2], chan_2.3);
4600         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4601         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4602         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
4603         assert_eq!(htlc_success_txn[0].input.len(), 1);
4604         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4605         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4606         assert_eq!(htlc_success_txn[1].input.len(), 1);
4607         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4608         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4609         check_spends!(htlc_success_txn[0], commitment_txn[0]);
4610         check_spends!(htlc_success_txn[1], commitment_txn[0]);
4611
4612         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4613         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4614         expect_pending_htlcs_forwardable!(nodes[1]);
4615         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4616         assert!(htlc_updates.update_add_htlcs.is_empty());
4617         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4618         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4619         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4620         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4621         check_added_monitors!(nodes[1], 1);
4622
4623         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4624         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4625         {
4626                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4627                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4628                 assert_eq!(events.len(), 1);
4629                 match events[0] {
4630                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4631                         },
4632                         _ => { panic!("Unexpected event"); }
4633                 }
4634         }
4635         let events = nodes[0].node.get_and_clear_pending_events();
4636         match events[0] {
4637                 Event::PaymentFailed { ref payment_hash, .. } => {
4638                         assert_eq!(*payment_hash, duplicate_payment_hash);
4639                 }
4640                 _ => panic!("Unexpected event"),
4641         }
4642
4643         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4644         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4645         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4646         assert!(updates.update_add_htlcs.is_empty());
4647         assert!(updates.update_fail_htlcs.is_empty());
4648         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4649         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4650         assert!(updates.update_fail_malformed_htlcs.is_empty());
4651         check_added_monitors!(nodes[1], 1);
4652
4653         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4654         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4655
4656         let events = nodes[0].node.get_and_clear_pending_events();
4657         match events[0] {
4658                 Event::PaymentSent { ref payment_preimage } => {
4659                         assert_eq!(*payment_preimage, our_payment_preimage);
4660                 }
4661                 _ => panic!("Unexpected event"),
4662         }
4663 }
4664
4665 #[test]
4666 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4667         let chanmon_cfgs = create_chanmon_cfgs(2);
4668         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4669         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4670         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4671
4672         // Create some initial channels
4673         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4674
4675         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4676         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4677         assert_eq!(local_txn[0].input.len(), 1);
4678         check_spends!(local_txn[0], chan_1.3);
4679
4680         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4681         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
4682         check_added_monitors!(nodes[1], 1);
4683         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4684         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4685         check_added_monitors!(nodes[1], 1);
4686         let events = nodes[1].node.get_and_clear_pending_msg_events();
4687         match events[0] {
4688                 MessageSendEvent::UpdateHTLCs { .. } => {},
4689                 _ => panic!("Unexpected event"),
4690         }
4691         match events[1] {
4692                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4693                 _ => panic!("Unexepected event"),
4694         }
4695         let node_txn = {
4696                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4697                 assert_eq!(node_txn[0].input.len(), 1);
4698                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4699                 check_spends!(node_txn[0], local_txn[0]);
4700                 vec![node_txn[0].clone(), node_txn[2].clone()]
4701         };
4702
4703         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4704         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
4705         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
4706
4707         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4708         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4709         assert_eq!(spend_txn.len(), 2);
4710         check_spends!(spend_txn[0], node_txn[0]);
4711         check_spends!(spend_txn[1], node_txn[1]);
4712 }
4713
4714 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4715         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4716         // unrevoked commitment transaction.
4717         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4718         // a remote RAA before they could be failed backwards (and combinations thereof).
4719         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4720         // use the same payment hashes.
4721         // Thus, we use a six-node network:
4722         //
4723         // A \         / E
4724         //    - C - D -
4725         // B /         \ F
4726         // And test where C fails back to A/B when D announces its latest commitment transaction
4727         let chanmon_cfgs = create_chanmon_cfgs(6);
4728         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
4729         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4730         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4731
4732         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4733         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4734         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4735         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4736         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4737
4738         // Rebalance and check output sanity...
4739         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4740         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4741         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
4742
4743         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4744         // 0th HTLC:
4745         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
4746         // 1st HTLC:
4747         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
4748         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV).unwrap();
4749         // 2nd HTLC:
4750         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_1); // not added < dust limit + HTLC tx fee
4751         // 3rd HTLC:
4752         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_2); // not added < dust limit + HTLC tx fee
4753         // 4th HTLC:
4754         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4755         // 5th HTLC:
4756         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4757         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4758         // 6th HTLC:
4759         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4760         // 7th HTLC:
4761         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4762
4763         // 8th HTLC:
4764         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4765         // 9th HTLC:
4766         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV).unwrap();
4767         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_5); // not added < dust limit + HTLC tx fee
4768
4769         // 10th HTLC:
4770         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
4771         // 11th HTLC:
4772         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4773         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4774
4775         // Double-check that six of the new HTLC were added
4776         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4777         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4778         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
4779         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
4780
4781         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4782         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4783         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
4784         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
4785         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
4786         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
4787         check_added_monitors!(nodes[4], 0);
4788         expect_pending_htlcs_forwardable!(nodes[4]);
4789         check_added_monitors!(nodes[4], 1);
4790
4791         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4792         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4793         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4794         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4795         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4796         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4797
4798         // Fail 3rd below-dust and 7th above-dust HTLCs
4799         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
4800         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
4801         check_added_monitors!(nodes[5], 0);
4802         expect_pending_htlcs_forwardable!(nodes[5]);
4803         check_added_monitors!(nodes[5], 1);
4804
4805         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4806         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4807         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4808         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4809
4810         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4811
4812         expect_pending_htlcs_forwardable!(nodes[3]);
4813         check_added_monitors!(nodes[3], 1);
4814         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4815         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4816         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4817         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4818         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4819         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4820         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4821         if deliver_last_raa {
4822                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4823         } else {
4824                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4825         }
4826
4827         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4828         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4829         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4830         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4831         //
4832         // We now broadcast the latest commitment transaction, which *should* result in failures for
4833         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4834         // the non-broadcast above-dust HTLCs.
4835         //
4836         // Alternatively, we may broadcast the previous commitment transaction, which should only
4837         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4838         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4839
4840         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4841         if announce_latest {
4842                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4843         } else {
4844                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4845         }
4846         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4847         check_closed_broadcast!(nodes[2], false);
4848         expect_pending_htlcs_forwardable!(nodes[2]);
4849         check_added_monitors!(nodes[2], 3);
4850
4851         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4852         assert_eq!(cs_msgs.len(), 2);
4853         let mut a_done = false;
4854         for msg in cs_msgs {
4855                 match msg {
4856                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4857                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4858                                 // should be failed-backwards here.
4859                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4860                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4861                                         for htlc in &updates.update_fail_htlcs {
4862                                                 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 });
4863                                         }
4864                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4865                                         assert!(!a_done);
4866                                         a_done = true;
4867                                         &nodes[0]
4868                                 } else {
4869                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4870                                         for htlc in &updates.update_fail_htlcs {
4871                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4872                                         }
4873                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4874                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4875                                         &nodes[1]
4876                                 };
4877                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4878                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4879                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4880                                 if announce_latest {
4881                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4882                                         if *node_id == nodes[0].node.get_our_node_id() {
4883                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4884                                         }
4885                                 }
4886                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4887                         },
4888                         _ => panic!("Unexpected event"),
4889                 }
4890         }
4891
4892         let as_events = nodes[0].node.get_and_clear_pending_events();
4893         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4894         let mut as_failds = HashSet::new();
4895         for event in as_events.iter() {
4896                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4897                         assert!(as_failds.insert(*payment_hash));
4898                         if *payment_hash != payment_hash_2 {
4899                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4900                         } else {
4901                                 assert!(!rejected_by_dest);
4902                         }
4903                 } else { panic!("Unexpected event"); }
4904         }
4905         assert!(as_failds.contains(&payment_hash_1));
4906         assert!(as_failds.contains(&payment_hash_2));
4907         if announce_latest {
4908                 assert!(as_failds.contains(&payment_hash_3));
4909                 assert!(as_failds.contains(&payment_hash_5));
4910         }
4911         assert!(as_failds.contains(&payment_hash_6));
4912
4913         let bs_events = nodes[1].node.get_and_clear_pending_events();
4914         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4915         let mut bs_failds = HashSet::new();
4916         for event in bs_events.iter() {
4917                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4918                         assert!(bs_failds.insert(*payment_hash));
4919                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4920                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4921                         } else {
4922                                 assert!(!rejected_by_dest);
4923                         }
4924                 } else { panic!("Unexpected event"); }
4925         }
4926         assert!(bs_failds.contains(&payment_hash_1));
4927         assert!(bs_failds.contains(&payment_hash_2));
4928         if announce_latest {
4929                 assert!(bs_failds.contains(&payment_hash_4));
4930         }
4931         assert!(bs_failds.contains(&payment_hash_5));
4932
4933         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4934         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4935         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4936         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4937         // PaymentFailureNetworkUpdates.
4938         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4939         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4940         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4941         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4942         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4943                 match event {
4944                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4945                         _ => panic!("Unexpected event"),
4946                 }
4947         }
4948 }
4949
4950 #[test]
4951 fn test_fail_backwards_latest_remote_announce_a() {
4952         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4953 }
4954
4955 #[test]
4956 fn test_fail_backwards_latest_remote_announce_b() {
4957         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4958 }
4959
4960 #[test]
4961 fn test_fail_backwards_previous_remote_announce() {
4962         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4963         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4964         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4965 }
4966
4967 #[test]
4968 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4969         let chanmon_cfgs = create_chanmon_cfgs(2);
4970         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4971         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4972         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4973
4974         // Create some initial channels
4975         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4976
4977         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
4978         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4979         assert_eq!(local_txn[0].input.len(), 1);
4980         check_spends!(local_txn[0], chan_1.3);
4981
4982         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4983         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4984         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4985         check_closed_broadcast!(nodes[0], false);
4986         check_added_monitors!(nodes[0], 1);
4987
4988         let htlc_timeout = {
4989                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4990                 assert_eq!(node_txn[0].input.len(), 1);
4991                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4992                 check_spends!(node_txn[0], local_txn[0]);
4993                 node_txn[0].clone()
4994         };
4995
4996         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4997         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
4998         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
4999         let events = nodes[0].node.get_and_clear_pending_events();
5000         assert_eq!(events.len(), 1);
5001         match events[0] {
5002                 Event::PaymentFailed { payment_hash, .. } => {
5003                         assert_eq!(payment_hash, our_payment_hash);
5004                 },
5005                 _ => panic!("Unexpected event"),
5006         }
5007
5008         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5009         let spend_txn = check_spendable_outputs!(nodes[0], 1);
5010         assert_eq!(spend_txn.len(), 3);
5011         assert_eq!(spend_txn[0], spend_txn[1]);
5012         check_spends!(spend_txn[0], local_txn[0]);
5013         check_spends!(spend_txn[2], htlc_timeout);
5014 }
5015
5016 #[test]
5017 fn test_static_output_closing_tx() {
5018         let chanmon_cfgs = create_chanmon_cfgs(2);
5019         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5020         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5021         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5022
5023         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5024
5025         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5026         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5027
5028         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5029         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5030         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5031
5032         let spend_txn = check_spendable_outputs!(nodes[0], 2);
5033         assert_eq!(spend_txn.len(), 1);
5034         check_spends!(spend_txn[0], closing_tx);
5035
5036         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5037         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5038
5039         let spend_txn = check_spendable_outputs!(nodes[1], 2);
5040         assert_eq!(spend_txn.len(), 1);
5041         check_spends!(spend_txn[0], closing_tx);
5042 }
5043
5044 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5045         let chanmon_cfgs = create_chanmon_cfgs(2);
5046         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5047         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5048         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5049         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5050
5051         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5052
5053         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5054         // present in B's local commitment transaction, but none of A's commitment transactions.
5055         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5056         check_added_monitors!(nodes[1], 1);
5057
5058         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5059         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5060         let events = nodes[0].node.get_and_clear_pending_events();
5061         assert_eq!(events.len(), 1);
5062         match events[0] {
5063                 Event::PaymentSent { payment_preimage } => {
5064                         assert_eq!(payment_preimage, our_payment_preimage);
5065                 },
5066                 _ => panic!("Unexpected event"),
5067         }
5068
5069         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5070         check_added_monitors!(nodes[0], 1);
5071         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5072         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5073         check_added_monitors!(nodes[1], 1);
5074
5075         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5076         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5077                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5078                 header.prev_blockhash = header.bitcoin_hash();
5079         }
5080         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5081         check_closed_broadcast!(nodes[1], false);
5082         check_added_monitors!(nodes[1], 1);
5083 }
5084
5085 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5086         let chanmon_cfgs = create_chanmon_cfgs(2);
5087         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5088         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5089         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5090         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5091
5092         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV).unwrap();
5093         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5094         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5095         check_added_monitors!(nodes[0], 1);
5096
5097         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5098
5099         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5100         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5101         // to "time out" the HTLC.
5102
5103         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5104
5105         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5106                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5107                 header.prev_blockhash = header.bitcoin_hash();
5108         }
5109         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5110         check_closed_broadcast!(nodes[0], false);
5111         check_added_monitors!(nodes[0], 1);
5112 }
5113
5114 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5115         let chanmon_cfgs = create_chanmon_cfgs(3);
5116         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5117         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5118         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5119         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5120
5121         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5122         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5123         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5124         // actually revoked.
5125         let htlc_value = if use_dust { 50000 } else { 3000000 };
5126         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5127         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5128         expect_pending_htlcs_forwardable!(nodes[1]);
5129         check_added_monitors!(nodes[1], 1);
5130
5131         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5132         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5133         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5134         check_added_monitors!(nodes[0], 1);
5135         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5136         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5137         check_added_monitors!(nodes[1], 1);
5138         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5139         check_added_monitors!(nodes[1], 1);
5140         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5141
5142         if check_revoke_no_close {
5143                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5144                 check_added_monitors!(nodes[0], 1);
5145         }
5146
5147         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5148         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5149                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5150                 header.prev_blockhash = header.bitcoin_hash();
5151         }
5152         if !check_revoke_no_close {
5153                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5154                 check_closed_broadcast!(nodes[0], false);
5155                 check_added_monitors!(nodes[0], 1);
5156         } else {
5157                 let events = nodes[0].node.get_and_clear_pending_events();
5158                 assert_eq!(events.len(), 1);
5159                 match events[0] {
5160                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
5161                                 assert_eq!(payment_hash, our_payment_hash);
5162                                 assert!(rejected_by_dest);
5163                         },
5164                         _ => panic!("Unexpected event"),
5165                 }
5166         }
5167 }
5168
5169 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5170 // There are only a few cases to test here:
5171 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5172 //    broadcastable commitment transactions result in channel closure,
5173 //  * its included in an unrevoked-but-previous remote commitment transaction,
5174 //  * its included in the latest remote or local commitment transactions.
5175 // We test each of the three possible commitment transactions individually and use both dust and
5176 // non-dust HTLCs.
5177 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5178 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5179 // tested for at least one of the cases in other tests.
5180 #[test]
5181 fn htlc_claim_single_commitment_only_a() {
5182         do_htlc_claim_local_commitment_only(true);
5183         do_htlc_claim_local_commitment_only(false);
5184
5185         do_htlc_claim_current_remote_commitment_only(true);
5186         do_htlc_claim_current_remote_commitment_only(false);
5187 }
5188
5189 #[test]
5190 fn htlc_claim_single_commitment_only_b() {
5191         do_htlc_claim_previous_remote_commitment_only(true, false);
5192         do_htlc_claim_previous_remote_commitment_only(false, false);
5193         do_htlc_claim_previous_remote_commitment_only(true, true);
5194         do_htlc_claim_previous_remote_commitment_only(false, true);
5195 }
5196
5197 fn run_onion_failure_test<F1,F2>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, callback_msg: F1, callback_node: F2, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
5198         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5199                                 F2: FnMut(),
5200 {
5201         run_onion_failure_test_with_fail_intercept(_name, test_case, nodes, route, payment_hash, callback_msg, |_|{}, callback_node, expected_retryable, expected_error_code, expected_channel_update);
5202 }
5203
5204 // test_case
5205 // 0: node1 fails backward
5206 // 1: final node fails backward
5207 // 2: payment completed but the user rejects the payment
5208 // 3: final node fails backward (but tamper onion payloads from node0)
5209 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5210 // 200: trigger error in the final node and tamper returning fail_htlc
5211 fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, mut callback_msg: F1, mut callback_fail: F2, mut callback_node: F3, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
5212         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5213                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5214                                 F3: FnMut(),
5215 {
5216
5217         // reset block height
5218         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5219         for ix in 0..nodes.len() {
5220                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5221         }
5222
5223         macro_rules! expect_event {
5224                 ($node: expr, $event_type: path) => {{
5225                         let events = $node.node.get_and_clear_pending_events();
5226                         assert_eq!(events.len(), 1);
5227                         match events[0] {
5228                                 $event_type { .. } => {},
5229                                 _ => panic!("Unexpected event"),
5230                         }
5231                 }}
5232         }
5233
5234         macro_rules! expect_htlc_forward {
5235                 ($node: expr) => {{
5236                         expect_event!($node, Event::PendingHTLCsForwardable);
5237                         $node.node.process_pending_htlc_forwards();
5238                 }}
5239         }
5240
5241         // 0 ~~> 2 send payment
5242         nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5243         check_added_monitors!(nodes[0], 1);
5244         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5245         // temper update_add (0 => 1)
5246         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5247         if test_case == 0 || test_case == 3 || test_case == 100 {
5248                 callback_msg(&mut update_add_0);
5249                 callback_node();
5250         }
5251         // 0 => 1 update_add & CS
5252         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5253         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5254
5255         let update_1_0 = match test_case {
5256                 0|100 => { // intermediate node failure; fail backward to 0
5257                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5258                         assert!(update_1_0.update_fail_htlcs.len()+update_1_0.update_fail_malformed_htlcs.len()==1 && (update_1_0.update_fail_htlcs.len()==1 || update_1_0.update_fail_malformed_htlcs.len()==1));
5259                         update_1_0
5260                 },
5261                 1|2|3|200 => { // final node failure; forwarding to 2
5262                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5263                         // forwarding on 1
5264                         if test_case != 200 {
5265                                 callback_node();
5266                         }
5267                         expect_htlc_forward!(&nodes[1]);
5268
5269                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5270                         check_added_monitors!(&nodes[1], 1);
5271                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5272                         // tamper update_add (1 => 2)
5273                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5274                         if test_case != 3 && test_case != 200 {
5275                                 callback_msg(&mut update_add_1);
5276                         }
5277
5278                         // 1 => 2
5279                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5280                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5281
5282                         if test_case == 2 || test_case == 200 {
5283                                 expect_htlc_forward!(&nodes[2]);
5284                                 expect_event!(&nodes[2], Event::PaymentReceived);
5285                                 callback_node();
5286                                 expect_pending_htlcs_forwardable!(nodes[2]);
5287                         }
5288
5289                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5290                         if test_case == 2 || test_case == 200 {
5291                                 check_added_monitors!(&nodes[2], 1);
5292                         }
5293                         assert!(update_2_1.update_fail_htlcs.len() == 1);
5294
5295                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5296                         if test_case == 200 {
5297                                 callback_fail(&mut fail_msg);
5298                         }
5299
5300                         // 2 => 1
5301                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5302                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5303
5304                         // backward fail on 1
5305                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5306                         assert!(update_1_0.update_fail_htlcs.len() == 1);
5307                         update_1_0
5308                 },
5309                 _ => unreachable!(),
5310         };
5311
5312         // 1 => 0 commitment_signed_dance
5313         if update_1_0.update_fail_htlcs.len() > 0 {
5314                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5315                 if test_case == 100 {
5316                         callback_fail(&mut fail_msg);
5317                 }
5318                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5319         } else {
5320                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5321         };
5322
5323         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5324
5325         let events = nodes[0].node.get_and_clear_pending_events();
5326         assert_eq!(events.len(), 1);
5327         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
5328                 assert_eq!(*rejected_by_dest, !expected_retryable);
5329                 assert_eq!(*error_code, expected_error_code);
5330         } else {
5331                 panic!("Uexpected event");
5332         }
5333
5334         let events = nodes[0].node.get_and_clear_pending_msg_events();
5335         if expected_channel_update.is_some() {
5336                 assert_eq!(events.len(), 1);
5337                 match events[0] {
5338                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5339                                 match update {
5340                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5341                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5342                                                         panic!("channel_update not found!");
5343                                                 }
5344                                         },
5345                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5346                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5347                                                         assert!(*short_channel_id == *expected_short_channel_id);
5348                                                         assert!(*is_permanent == *expected_is_permanent);
5349                                                 } else {
5350                                                         panic!("Unexpected message event");
5351                                                 }
5352                                         },
5353                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5354                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5355                                                         assert!(*node_id == *expected_node_id);
5356                                                         assert!(*is_permanent == *expected_is_permanent);
5357                                                 } else {
5358                                                         panic!("Unexpected message event");
5359                                                 }
5360                                         },
5361                                 }
5362                         },
5363                         _ => panic!("Unexpected message event"),
5364                 }
5365         } else {
5366                 assert_eq!(events.len(), 0);
5367         }
5368 }
5369
5370 impl msgs::ChannelUpdate {
5371         fn dummy() -> msgs::ChannelUpdate {
5372                 use secp256k1::ffi::Signature as FFISignature;
5373                 use secp256k1::Signature;
5374                 msgs::ChannelUpdate {
5375                         signature: Signature::from(FFISignature::new()),
5376                         contents: msgs::UnsignedChannelUpdate {
5377                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
5378                                 short_channel_id: 0,
5379                                 timestamp: 0,
5380                                 flags: 0,
5381                                 cltv_expiry_delta: 0,
5382                                 htlc_minimum_msat: 0,
5383                                 fee_base_msat: 0,
5384                                 fee_proportional_millionths: 0,
5385                                 excess_data: vec![],
5386                         }
5387                 }
5388         }
5389 }
5390
5391 struct BogusOnionHopData {
5392         data: Vec<u8>
5393 }
5394 impl BogusOnionHopData {
5395         fn new(orig: msgs::OnionHopData) -> Self {
5396                 Self { data: orig.encode() }
5397         }
5398 }
5399 impl Writeable for BogusOnionHopData {
5400         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5401                 writer.write_all(&self.data[..])
5402         }
5403 }
5404
5405 #[test]
5406 fn test_onion_failure() {
5407         use ln::msgs::ChannelUpdate;
5408         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5409         use secp256k1;
5410
5411         const BADONION: u16 = 0x8000;
5412         const PERM: u16 = 0x4000;
5413         const NODE: u16 = 0x2000;
5414         const UPDATE: u16 = 0x1000;
5415
5416         let chanmon_cfgs = create_chanmon_cfgs(3);
5417         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5418         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5419         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5420         for node in nodes.iter() {
5421                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5422         }
5423         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported())];
5424         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5425         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5426         // positve case
5427         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5428
5429         // intermediate node failure
5430         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5431                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5432                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5433                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5434                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5435                 let mut new_payloads = Vec::new();
5436                 for payload in onion_payloads.drain(..) {
5437                         new_payloads.push(BogusOnionHopData::new(payload));
5438                 }
5439                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5440                 // describing a length-1 TLV payload, which is obviously bogus.
5441                 new_payloads[0].data[0] = 1;
5442                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5443         }, ||{}, true, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
5444
5445         // final node failure
5446         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5447                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5448                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5449                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5450                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5451                 let mut new_payloads = Vec::new();
5452                 for payload in onion_payloads.drain(..) {
5453                         new_payloads.push(BogusOnionHopData::new(payload));
5454                 }
5455                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5456                 // length-1 TLV payload, which is obviously bogus.
5457                 new_payloads[1].data[0] = 1;
5458                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5459         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5460
5461         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5462         // receiving simulated fail messages
5463         // intermediate node failure
5464         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5465                 // trigger error
5466                 msg.amount_msat -= 1;
5467         }, |msg| {
5468                 // and tamper returning error message
5469                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5470                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5471                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5472         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
5473
5474         // final node failure
5475         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5476                 // and tamper returning error message
5477                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5478                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5479                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5480         }, ||{
5481                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5482         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
5483
5484         // intermediate node failure
5485         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5486                 msg.amount_msat -= 1;
5487         }, |msg| {
5488                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5489                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5490                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5491         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5492
5493         // final node failure
5494         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5495                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5496                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5497                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5498         }, ||{
5499                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5500         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5501
5502         // intermediate node failure
5503         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5504                 msg.amount_msat -= 1;
5505         }, |msg| {
5506                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5507                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5508                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5509         }, ||{
5510                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5511         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5512
5513         // final node failure
5514         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5515                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5516                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5517                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5518         }, ||{
5519                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5520         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5521
5522         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5523                 Some(BADONION|PERM|4), None);
5524
5525         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5526                 Some(BADONION|PERM|5), None);
5527
5528         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5529                 Some(BADONION|PERM|6), None);
5530
5531         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5532                 msg.amount_msat -= 1;
5533         }, |msg| {
5534                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5535                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5536                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5537         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5538
5539         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5540                 msg.amount_msat -= 1;
5541         }, |msg| {
5542                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5543                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5544                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5545                 // short_channel_id from the processing node
5546         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5547
5548         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5549                 msg.amount_msat -= 1;
5550         }, |msg| {
5551                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5552                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5553                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5554                 // short_channel_id from the processing node
5555         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5556
5557         let mut bogus_route = route.clone();
5558         bogus_route.paths[0][1].short_channel_id -= 1;
5559         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5560           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
5561
5562         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5563         let mut bogus_route = route.clone();
5564         let route_len = bogus_route.paths[0].len();
5565         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
5566         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5567
5568         //TODO: with new config API, we will be able to generate both valid and
5569         //invalid channel_update cases.
5570         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5571                 msg.amount_msat -= 1;
5572         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5573
5574         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5575                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5576                 msg.cltv_expiry -= 1;
5577         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5578
5579         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5580                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5581                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5582
5583                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5584         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5585
5586         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5587                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5588         }, false, Some(PERM|15), None);
5589
5590         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5591                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5592                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5593
5594                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5595         }, || {}, true, Some(17), None);
5596
5597         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5598                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5599                         for f in pending_forwards.iter_mut() {
5600                                 match f {
5601                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5602                                                 forward_info.outgoing_cltv_value += 1,
5603                                         _ => {},
5604                                 }
5605                         }
5606                 }
5607         }, true, Some(18), None);
5608
5609         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5610                 // violate amt_to_forward > msg.amount_msat
5611                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5612                         for f in pending_forwards.iter_mut() {
5613                                 match f {
5614                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5615                                                 forward_info.amt_to_forward -= 1,
5616                                         _ => {},
5617                                 }
5618                         }
5619                 }
5620         }, true, Some(19), None);
5621
5622         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5623                 // disconnect event to the channel between nodes[1] ~ nodes[2]
5624                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5625                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5626         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5627         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5628
5629         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5630                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5631                 let mut route = route.clone();
5632                 let height = 1;
5633                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
5634                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5635                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
5636                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5637                 msg.cltv_expiry = htlc_cltv;
5638                 msg.onion_routing_packet = onion_packet;
5639         }, ||{}, true, Some(21), None);
5640 }
5641
5642 #[test]
5643 #[should_panic]
5644 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5645         let chanmon_cfgs = create_chanmon_cfgs(2);
5646         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5647         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5648         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5649         //Force duplicate channel ids
5650         for node in nodes.iter() {
5651                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5652         }
5653
5654         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5655         let channel_value_satoshis=10000;
5656         let push_msat=10001;
5657         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5658         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5659         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5660
5661         //Create a second channel with a channel_id collision
5662         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5663 }
5664
5665 #[test]
5666 fn bolt2_open_channel_sending_node_checks_part2() {
5667         let chanmon_cfgs = create_chanmon_cfgs(2);
5668         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5669         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5670         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5671
5672         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5673         let channel_value_satoshis=2^24;
5674         let push_msat=10001;
5675         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5676
5677         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5678         let channel_value_satoshis=10000;
5679         // Test when push_msat is equal to 1000 * funding_satoshis.
5680         let push_msat=1000*channel_value_satoshis+1;
5681         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5682
5683         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5684         let channel_value_satoshis=10000;
5685         let push_msat=10001;
5686         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
5687         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5688         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5689
5690         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5691         // 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
5692         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5693
5694         // 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.
5695         assert!(BREAKDOWN_TIMEOUT>0);
5696         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5697
5698         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5699         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5700         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5701
5702         // 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.
5703         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5704         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5705         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5706         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5707         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5708 }
5709
5710 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5711 // 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.
5712 //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.
5713
5714 #[test]
5715 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5716         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5717         let chanmon_cfgs = create_chanmon_cfgs(2);
5718         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5719         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5720         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5721         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5722         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5723         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5724
5725         route.paths[0][0].fee_msat = 100;
5726
5727         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5728                 assert_eq!(err, "Cannot send less than their minimum HTLC value"));
5729         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5730         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5731 }
5732
5733 #[test]
5734 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
5735         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5736         let chanmon_cfgs = create_chanmon_cfgs(2);
5737         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5738         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5739         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5740         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5741         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5742         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5743
5744         route.paths[0][0].fee_msat = 0;
5745
5746         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5747                 assert_eq!(err, "Cannot send 0-msat HTLC"));
5748         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5749         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
5750 }
5751
5752 #[test]
5753 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
5754         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5755         let chanmon_cfgs = create_chanmon_cfgs(2);
5756         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5757         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5758         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5759         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5760         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5761         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5762
5763         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5764         check_added_monitors!(nodes[0], 1);
5765         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5766         updates.update_add_htlcs[0].amount_msat = 0;
5767
5768         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5769         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
5770         check_closed_broadcast!(nodes[1], true).unwrap();
5771         check_added_monitors!(nodes[1], 1);
5772 }
5773
5774 #[test]
5775 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5776         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5777         //It is enforced when constructing a route.
5778         let chanmon_cfgs = create_chanmon_cfgs(2);
5779         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5780         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5781         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5782         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5783         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5784         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5785
5786         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { err },
5787                 assert_eq!(err, "Channel CLTV overflowed?!"));
5788 }
5789
5790 #[test]
5791 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5792         //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.
5793         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5794         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5795         let chanmon_cfgs = create_chanmon_cfgs(2);
5796         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5797         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5798         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5799         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5800         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5801
5802         for i in 0..max_accepted_htlcs {
5803                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5804                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5805                 let payment_event = {
5806                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5807                         check_added_monitors!(nodes[0], 1);
5808
5809                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5810                         assert_eq!(events.len(), 1);
5811                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5812                                 assert_eq!(htlcs[0].htlc_id, i);
5813                         } else {
5814                                 assert!(false);
5815                         }
5816                         SendEvent::from_event(events.remove(0))
5817                 };
5818                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5819                 check_added_monitors!(nodes[1], 0);
5820                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5821
5822                 expect_pending_htlcs_forwardable!(nodes[1]);
5823                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5824         }
5825         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5826         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5827         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5828                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
5829
5830         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5831         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5832 }
5833
5834 #[test]
5835 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5836         //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.
5837         let chanmon_cfgs = create_chanmon_cfgs(2);
5838         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5839         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5840         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5841         let channel_value = 100000;
5842         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5843         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5844
5845         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5846
5847         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5848         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5849         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5850                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
5851
5852         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5853         nodes[0].logger.assert_log("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);
5854
5855         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5856 }
5857
5858 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5859 #[test]
5860 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5861         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5862         let chanmon_cfgs = create_chanmon_cfgs(2);
5863         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5864         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5865         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5866         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5867         let htlc_minimum_msat: u64;
5868         {
5869                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5870                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5871                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5872         }
5873         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5874         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5875         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5876         check_added_monitors!(nodes[0], 1);
5877         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5878         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5879         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5880         assert!(nodes[1].node.list_channels().is_empty());
5881         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5882         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5883         check_added_monitors!(nodes[1], 1);
5884 }
5885
5886 #[test]
5887 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5888         //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
5889         let chanmon_cfgs = create_chanmon_cfgs(2);
5890         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5891         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5892         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5893         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5894
5895         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5896
5897         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5898         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5899         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5900         check_added_monitors!(nodes[0], 1);
5901         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5902
5903         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5904         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5905
5906         assert!(nodes[1].node.list_channels().is_empty());
5907         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5908         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5909         check_added_monitors!(nodes[1], 1);
5910 }
5911
5912 #[test]
5913 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5914         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5915         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5916         let chanmon_cfgs = create_chanmon_cfgs(2);
5917         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5918         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5919         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5920         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5921         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5922         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5923
5924         let session_priv = SecretKey::from_slice(&{
5925                 let mut session_key = [0; 32];
5926                 let mut rng = thread_rng();
5927                 rng.fill_bytes(&mut session_key);
5928                 session_key
5929         }).expect("RNG is bad!");
5930
5931         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5932         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
5933         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
5934         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5935
5936         let mut msg = msgs::UpdateAddHTLC {
5937                 channel_id: chan.2,
5938                 htlc_id: 0,
5939                 amount_msat: 1000,
5940                 payment_hash: our_payment_hash,
5941                 cltv_expiry: htlc_cltv,
5942                 onion_routing_packet: onion_packet.clone(),
5943         };
5944
5945         for i in 0..super::channel::OUR_MAX_HTLCS {
5946                 msg.htlc_id = i as u64;
5947                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5948         }
5949         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5950         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5951
5952         assert!(nodes[1].node.list_channels().is_empty());
5953         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5954         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5955         check_added_monitors!(nodes[1], 1);
5956 }
5957
5958 #[test]
5959 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5960         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5961         let chanmon_cfgs = create_chanmon_cfgs(2);
5962         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5963         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5964         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5965         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5966         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5967         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5968         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5969         check_added_monitors!(nodes[0], 1);
5970         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5971         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5972         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5973
5974         assert!(nodes[1].node.list_channels().is_empty());
5975         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5976         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5977         check_added_monitors!(nodes[1], 1);
5978 }
5979
5980 #[test]
5981 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5982         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5983         let chanmon_cfgs = create_chanmon_cfgs(2);
5984         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5985         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5986         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5987         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5988         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5989         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5990         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5991         check_added_monitors!(nodes[0], 1);
5992         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5993         updates.update_add_htlcs[0].cltv_expiry = 500000000;
5994         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5995
5996         assert!(nodes[1].node.list_channels().is_empty());
5997         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5998         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
5999         check_added_monitors!(nodes[1], 1);
6000 }
6001
6002 #[test]
6003 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6004         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6005         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6006         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6007         let chanmon_cfgs = create_chanmon_cfgs(2);
6008         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6009         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6010         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6011         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6012         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6013         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6014         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6015         check_added_monitors!(nodes[0], 1);
6016         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6017         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6018
6019         //Disconnect and Reconnect
6020         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6021         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6022         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6023         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6024         assert_eq!(reestablish_1.len(), 1);
6025         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6026         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6027         assert_eq!(reestablish_2.len(), 1);
6028         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6029         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6030         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6031         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6032
6033         //Resend HTLC
6034         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6035         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6036         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6037         check_added_monitors!(nodes[1], 1);
6038         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6039
6040         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6041
6042         assert!(nodes[1].node.list_channels().is_empty());
6043         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6044         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
6045         check_added_monitors!(nodes[1], 1);
6046 }
6047
6048 #[test]
6049 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6050         //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.
6051
6052         let chanmon_cfgs = create_chanmon_cfgs(2);
6053         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6054         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6055         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6056         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6057
6058         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6059         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6060         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6061         check_added_monitors!(nodes[0], 1);
6062         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6063         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6064
6065         let update_msg = msgs::UpdateFulfillHTLC{
6066                 channel_id: chan.2,
6067                 htlc_id: 0,
6068                 payment_preimage: our_payment_preimage,
6069         };
6070
6071         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6072
6073         assert!(nodes[0].node.list_channels().is_empty());
6074         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6075         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6076         check_added_monitors!(nodes[0], 1);
6077 }
6078
6079 #[test]
6080 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6081         //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.
6082
6083         let chanmon_cfgs = create_chanmon_cfgs(2);
6084         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6085         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6086         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6087         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6088
6089         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6090         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6091         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6092         check_added_monitors!(nodes[0], 1);
6093         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6094         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6095
6096         let update_msg = msgs::UpdateFailHTLC{
6097                 channel_id: chan.2,
6098                 htlc_id: 0,
6099                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6100         };
6101
6102         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6103
6104         assert!(nodes[0].node.list_channels().is_empty());
6105         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6106         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6107         check_added_monitors!(nodes[0], 1);
6108 }
6109
6110 #[test]
6111 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6112         //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.
6113
6114         let chanmon_cfgs = create_chanmon_cfgs(2);
6115         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6116         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6117         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6118         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6119
6120         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6121         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6122         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6123         check_added_monitors!(nodes[0], 1);
6124         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6125         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6126
6127         let update_msg = msgs::UpdateFailMalformedHTLC{
6128                 channel_id: chan.2,
6129                 htlc_id: 0,
6130                 sha256_of_onion: [1; 32],
6131                 failure_code: 0x8000,
6132         };
6133
6134         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6135
6136         assert!(nodes[0].node.list_channels().is_empty());
6137         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6138         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6139         check_added_monitors!(nodes[0], 1);
6140 }
6141
6142 #[test]
6143 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6144         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6145
6146         let chanmon_cfgs = create_chanmon_cfgs(2);
6147         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6148         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6149         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6150         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6151
6152         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6153
6154         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6155         check_added_monitors!(nodes[1], 1);
6156
6157         let events = nodes[1].node.get_and_clear_pending_msg_events();
6158         assert_eq!(events.len(), 1);
6159         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6160                 match events[0] {
6161                         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, .. } } => {
6162                                 assert!(update_add_htlcs.is_empty());
6163                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6164                                 assert!(update_fail_htlcs.is_empty());
6165                                 assert!(update_fail_malformed_htlcs.is_empty());
6166                                 assert!(update_fee.is_none());
6167                                 update_fulfill_htlcs[0].clone()
6168                         },
6169                         _ => panic!("Unexpected event"),
6170                 }
6171         };
6172
6173         update_fulfill_msg.htlc_id = 1;
6174
6175         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6176
6177         assert!(nodes[0].node.list_channels().is_empty());
6178         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6179         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6180         check_added_monitors!(nodes[0], 1);
6181 }
6182
6183 #[test]
6184 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6185         //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.
6186
6187         let chanmon_cfgs = create_chanmon_cfgs(2);
6188         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6189         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6190         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6191         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6192
6193         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6194
6195         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6196         check_added_monitors!(nodes[1], 1);
6197
6198         let events = nodes[1].node.get_and_clear_pending_msg_events();
6199         assert_eq!(events.len(), 1);
6200         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6201                 match events[0] {
6202                         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, .. } } => {
6203                                 assert!(update_add_htlcs.is_empty());
6204                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6205                                 assert!(update_fail_htlcs.is_empty());
6206                                 assert!(update_fail_malformed_htlcs.is_empty());
6207                                 assert!(update_fee.is_none());
6208                                 update_fulfill_htlcs[0].clone()
6209                         },
6210                         _ => panic!("Unexpected event"),
6211                 }
6212         };
6213
6214         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6215
6216         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6217
6218         assert!(nodes[0].node.list_channels().is_empty());
6219         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6220         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
6221         check_added_monitors!(nodes[0], 1);
6222 }
6223
6224 #[test]
6225 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6226         //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.
6227
6228         let chanmon_cfgs = create_chanmon_cfgs(2);
6229         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6230         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6231         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6232         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6233         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6234         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6235         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6236         check_added_monitors!(nodes[0], 1);
6237
6238         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6239         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6240
6241         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6242         check_added_monitors!(nodes[1], 0);
6243         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6244
6245         let events = nodes[1].node.get_and_clear_pending_msg_events();
6246
6247         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6248                 match events[0] {
6249                         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, .. } } => {
6250                                 assert!(update_add_htlcs.is_empty());
6251                                 assert!(update_fulfill_htlcs.is_empty());
6252                                 assert!(update_fail_htlcs.is_empty());
6253                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6254                                 assert!(update_fee.is_none());
6255                                 update_fail_malformed_htlcs[0].clone()
6256                         },
6257                         _ => panic!("Unexpected event"),
6258                 }
6259         };
6260         update_msg.failure_code &= !0x8000;
6261         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6262
6263         assert!(nodes[0].node.list_channels().is_empty());
6264         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6265         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6266         check_added_monitors!(nodes[0], 1);
6267 }
6268
6269 #[test]
6270 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6271         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6272         //    * 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.
6273
6274         let chanmon_cfgs = create_chanmon_cfgs(3);
6275         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6276         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6277         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6278         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6279         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6280
6281         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
6282         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6283
6284         //First hop
6285         let mut payment_event = {
6286                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6287                 check_added_monitors!(nodes[0], 1);
6288                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6289                 assert_eq!(events.len(), 1);
6290                 SendEvent::from_event(events.remove(0))
6291         };
6292         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6293         check_added_monitors!(nodes[1], 0);
6294         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6295         expect_pending_htlcs_forwardable!(nodes[1]);
6296         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6297         assert_eq!(events_2.len(), 1);
6298         check_added_monitors!(nodes[1], 1);
6299         payment_event = SendEvent::from_event(events_2.remove(0));
6300         assert_eq!(payment_event.msgs.len(), 1);
6301
6302         //Second Hop
6303         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6304         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6305         check_added_monitors!(nodes[2], 0);
6306         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6307
6308         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6309         assert_eq!(events_3.len(), 1);
6310         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6311                 match events_3[0] {
6312                         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 } } => {
6313                                 assert!(update_add_htlcs.is_empty());
6314                                 assert!(update_fulfill_htlcs.is_empty());
6315                                 assert!(update_fail_htlcs.is_empty());
6316                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6317                                 assert!(update_fee.is_none());
6318                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6319                         },
6320                         _ => panic!("Unexpected event"),
6321                 }
6322         };
6323
6324         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6325
6326         check_added_monitors!(nodes[1], 0);
6327         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6328         expect_pending_htlcs_forwardable!(nodes[1]);
6329         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6330         assert_eq!(events_4.len(), 1);
6331
6332         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6333         match events_4[0] {
6334                 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, .. } } => {
6335                         assert!(update_add_htlcs.is_empty());
6336                         assert!(update_fulfill_htlcs.is_empty());
6337                         assert_eq!(update_fail_htlcs.len(), 1);
6338                         assert!(update_fail_malformed_htlcs.is_empty());
6339                         assert!(update_fee.is_none());
6340                 },
6341                 _ => panic!("Unexpected event"),
6342         };
6343
6344         check_added_monitors!(nodes[1], 1);
6345 }
6346
6347 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6348         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6349         // 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
6350         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6351
6352         let chanmon_cfgs = create_chanmon_cfgs(2);
6353         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6354         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6355         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6356         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6357
6358         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6359
6360         // We route 2 dust-HTLCs between A and B
6361         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6362         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6363         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6364
6365         // Cache one local commitment tx as previous
6366         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6367
6368         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6369         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
6370         check_added_monitors!(nodes[1], 0);
6371         expect_pending_htlcs_forwardable!(nodes[1]);
6372         check_added_monitors!(nodes[1], 1);
6373
6374         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6375         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6376         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6377         check_added_monitors!(nodes[0], 1);
6378
6379         // Cache one local commitment tx as lastest
6380         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6381
6382         let events = nodes[0].node.get_and_clear_pending_msg_events();
6383         match events[0] {
6384                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6385                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6386                 },
6387                 _ => panic!("Unexpected event"),
6388         }
6389         match events[1] {
6390                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6391                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6392                 },
6393                 _ => panic!("Unexpected event"),
6394         }
6395
6396         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6397         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6398         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6399
6400         if announce_latest {
6401                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
6402         } else {
6403                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
6404         }
6405
6406         check_closed_broadcast!(nodes[0], false);
6407         check_added_monitors!(nodes[0], 1);
6408
6409         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6410         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
6411         let events = nodes[0].node.get_and_clear_pending_events();
6412         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6413         assert_eq!(events.len(), 2);
6414         let mut first_failed = false;
6415         for event in events {
6416                 match event {
6417                         Event::PaymentFailed { payment_hash, .. } => {
6418                                 if payment_hash == payment_hash_1 {
6419                                         assert!(!first_failed);
6420                                         first_failed = true;
6421                                 } else {
6422                                         assert_eq!(payment_hash, payment_hash_2);
6423                                 }
6424                         }
6425                         _ => panic!("Unexpected event"),
6426                 }
6427         }
6428 }
6429
6430 #[test]
6431 fn test_failure_delay_dust_htlc_local_commitment() {
6432         do_test_failure_delay_dust_htlc_local_commitment(true);
6433         do_test_failure_delay_dust_htlc_local_commitment(false);
6434 }
6435
6436 #[test]
6437 fn test_no_failure_dust_htlc_local_commitment() {
6438         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
6439         // prone to error, we test here that a dummy transaction don't fail them.
6440
6441         let chanmon_cfgs = create_chanmon_cfgs(2);
6442         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6443         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6444         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6445         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6446
6447         // Rebalance a bit
6448         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6449
6450         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6451         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6452
6453         // We route 2 dust-HTLCs between A and B
6454         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6455         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
6456
6457         // Build a dummy invalid transaction trying to spend a commitment tx
6458         let input = TxIn {
6459                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6460                 script_sig: Script::new(),
6461                 sequence: 0,
6462                 witness: Vec::new(),
6463         };
6464
6465         let outp = TxOut {
6466                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6467                 value: 10000,
6468         };
6469
6470         let dummy_tx = Transaction {
6471                 version: 2,
6472                 lock_time: 0,
6473                 input: vec![input],
6474                 output: vec![outp]
6475         };
6476
6477         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6478         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6479         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6480         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6481         // We broadcast a few more block to check everything is all right
6482         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
6483         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6484         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6485
6486         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6487         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6488 }
6489
6490 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6491         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6492         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6493         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6494         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6495         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6496         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6497
6498         let chanmon_cfgs = create_chanmon_cfgs(3);
6499         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6500         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6501         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6502         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6503
6504         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6505
6506         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6507         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6508
6509         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6510         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
6511
6512         // We revoked bs_commitment_tx
6513         if revoked {
6514                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6515                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6516         }
6517
6518         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6519         let mut timeout_tx = Vec::new();
6520         if local {
6521                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6522                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6523                 check_closed_broadcast!(nodes[0], false);
6524                 check_added_monitors!(nodes[0], 1);
6525                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6526                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6527                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6528                 let events = nodes[0].node.get_and_clear_pending_events();
6529                 assert_eq!(events.len(), 1);
6530                 match events[0] {
6531                         Event::PaymentFailed { payment_hash, .. } => {
6532                                 assert_eq!(payment_hash, dust_hash);
6533                         },
6534                         _ => panic!("Unexpected event"),
6535                 }
6536                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6537                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6538                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6539                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6540                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6541                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6542                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6543                 let events = nodes[0].node.get_and_clear_pending_events();
6544                 assert_eq!(events.len(), 1);
6545                 match events[0] {
6546                         Event::PaymentFailed { payment_hash, .. } => {
6547                                 assert_eq!(payment_hash, non_dust_hash);
6548                         },
6549                         _ => panic!("Unexpected event"),
6550                 }
6551         } else {
6552                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6553                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6554                 check_closed_broadcast!(nodes[0], false);
6555                 check_added_monitors!(nodes[0], 1);
6556                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6557                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6558                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6559                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6560                 if !revoked {
6561                         let events = nodes[0].node.get_and_clear_pending_events();
6562                         assert_eq!(events.len(), 1);
6563                         match events[0] {
6564                                 Event::PaymentFailed { payment_hash, .. } => {
6565                                         assert_eq!(payment_hash, dust_hash);
6566                                 },
6567                                 _ => panic!("Unexpected event"),
6568                         }
6569                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6570                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6571                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6572                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6573                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6574                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6575                         let events = nodes[0].node.get_and_clear_pending_events();
6576                         assert_eq!(events.len(), 1);
6577                         match events[0] {
6578                                 Event::PaymentFailed { payment_hash, .. } => {
6579                                         assert_eq!(payment_hash, non_dust_hash);
6580                                 },
6581                                 _ => panic!("Unexpected event"),
6582                         }
6583                 } else {
6584                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6585                         // commitment tx
6586                         let events = nodes[0].node.get_and_clear_pending_events();
6587                         assert_eq!(events.len(), 2);
6588                         let first;
6589                         match events[0] {
6590                                 Event::PaymentFailed { payment_hash, .. } => {
6591                                         if payment_hash == dust_hash { first = true; }
6592                                         else { first = false; }
6593                                 },
6594                                 _ => panic!("Unexpected event"),
6595                         }
6596                         match events[1] {
6597                                 Event::PaymentFailed { payment_hash, .. } => {
6598                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6599                                         else { assert_eq!(payment_hash, dust_hash); }
6600                                 },
6601                                 _ => panic!("Unexpected event"),
6602                         }
6603                 }
6604         }
6605 }
6606
6607 #[test]
6608 fn test_sweep_outbound_htlc_failure_update() {
6609         do_test_sweep_outbound_htlc_failure_update(false, true);
6610         do_test_sweep_outbound_htlc_failure_update(false, false);
6611         do_test_sweep_outbound_htlc_failure_update(true, false);
6612 }
6613
6614 #[test]
6615 fn test_upfront_shutdown_script() {
6616         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6617         // enforce it at shutdown message
6618
6619         let mut config = UserConfig::default();
6620         config.channel_options.announced_channel = true;
6621         config.peer_channel_config_limits.force_announced_channel_preference = false;
6622         config.channel_options.commit_upfront_shutdown_pubkey = false;
6623         let user_cfgs = [None, Some(config), None];
6624         let chanmon_cfgs = create_chanmon_cfgs(3);
6625         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6626         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6627         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6628
6629         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6630         let flags = InitFeatures::supported();
6631         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6632         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6633         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6634         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6635         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
6636         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6637         assert_eq!(check_closed_broadcast!(nodes[2], true).unwrap().data, "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6638         check_added_monitors!(nodes[2], 1);
6639
6640         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6641         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6642         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6643         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6644         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6645         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6646         let events = nodes[2].node.get_and_clear_pending_msg_events();
6647         assert_eq!(events.len(), 1);
6648         match events[0] {
6649                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6650                 _ => panic!("Unexpected event"),
6651         }
6652
6653         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6654         let mut flags_no = InitFeatures::supported();
6655         flags_no.unset_upfront_shutdown_script();
6656         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6657         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6658         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6659         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6660         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6661         let events = nodes[1].node.get_and_clear_pending_msg_events();
6662         assert_eq!(events.len(), 1);
6663         match events[0] {
6664                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6665                 _ => panic!("Unexpected event"),
6666         }
6667
6668         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6669         // channel smoothly, opt-out is from channel initiator here
6670         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6671         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6672         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6673         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6674         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6675         let events = nodes[0].node.get_and_clear_pending_msg_events();
6676         assert_eq!(events.len(), 1);
6677         match events[0] {
6678                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6679                 _ => panic!("Unexpected event"),
6680         }
6681
6682         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6683         //// channel smoothly
6684         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6685         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6686         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6687         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6688         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6689         let events = nodes[0].node.get_and_clear_pending_msg_events();
6690         assert_eq!(events.len(), 2);
6691         match events[0] {
6692                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6693                 _ => panic!("Unexpected event"),
6694         }
6695         match events[1] {
6696                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6697                 _ => panic!("Unexpected event"),
6698         }
6699 }
6700
6701 #[test]
6702 fn test_user_configurable_csv_delay() {
6703         // We test our channel constructors yield errors when we pass them absurd csv delay
6704
6705         let mut low_our_to_self_config = UserConfig::default();
6706         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6707         let mut high_their_to_self_config = UserConfig::default();
6708         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6709         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6710         let chanmon_cfgs = create_chanmon_cfgs(2);
6711         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6712         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6713         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6714
6715         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6716         let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
6717         if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6718                 match error {
6719                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6720                         _ => panic!("Unexpected event"),
6721                 }
6722         } else { assert!(false) }
6723
6724         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6725         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6726         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6727         open_channel.to_self_delay = 200;
6728         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6729                 match error {
6730                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6731                         _ => panic!("Unexpected event"),
6732                 }
6733         } else { assert!(false); }
6734
6735         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6736         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6737         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
6738         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6739         accept_channel.to_self_delay = 200;
6740         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6741         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6742                 match action {
6743                         &ErrorAction::SendErrorMessage { ref msg } => {
6744                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6745                         },
6746                         _ => { assert!(false); }
6747                 }
6748         } else { assert!(false); }
6749
6750         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6751         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6752         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6753         open_channel.to_self_delay = 200;
6754         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &high_their_to_self_config) {
6755                 match error {
6756                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6757                         _ => panic!("Unexpected event"),
6758                 }
6759         } else { assert!(false); }
6760 }
6761
6762 #[test]
6763 fn test_data_loss_protect() {
6764         // We want to be sure that :
6765         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6766         // * we close channel in case of detecting other being fallen behind
6767         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6768         let keys_manager;
6769         let fee_estimator;
6770         let tx_broadcaster;
6771         let monitor;
6772         let node_state_0;
6773         let chanmon_cfgs = create_chanmon_cfgs(2);
6774         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6775         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6776         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6777
6778         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6779
6780         // Cache node A state before any channel update
6781         let previous_node_state = nodes[0].node.encode();
6782         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6783         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6784
6785         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6786         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6787
6788         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6789         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6790
6791         // Restore node A from previous state
6792         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6793         let mut chan_monitor = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6794         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6795         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), broadcasted_txn: Mutex::new(HashMap::new())};
6796         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
6797         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger));
6798         monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &tx_broadcaster, logger.clone(), &fee_estimator);
6799         node_state_0 = {
6800                 let mut channel_monitors = HashMap::new();
6801                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6802                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6803                         keys_manager: &keys_manager,
6804                         fee_estimator: &fee_estimator,
6805                         monitor: &monitor,
6806                         logger: Arc::clone(&logger),
6807                         tx_broadcaster: &tx_broadcaster,
6808                         default_config: UserConfig::default(),
6809                         channel_monitors: &mut channel_monitors,
6810                 }).unwrap().1
6811         };
6812         nodes[0].node = &node_state_0;
6813         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
6814         nodes[0].chan_monitor = &monitor;
6815         nodes[0].chain_monitor = chain_monitor;
6816
6817         nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6818         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6819         nodes[0].block_notifier.register_listener(nodes[0].node);
6820
6821         check_added_monitors!(nodes[0], 1);
6822
6823         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6824         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6825
6826         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6827
6828         // Check we update monitor following learning of per_commitment_point from B
6829         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6830         check_added_monitors!(nodes[0], 2);
6831
6832         {
6833                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6834                 assert_eq!(node_txn.len(), 0);
6835         }
6836
6837         let mut reestablish_1 = Vec::with_capacity(1);
6838         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6839                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6840                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6841                         reestablish_1.push(msg.clone());
6842                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6843                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6844                         match action {
6845                                 &ErrorAction::SendErrorMessage { ref msg } => {
6846                                         assert_eq!(msg.data, "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting");
6847                                 },
6848                                 _ => panic!("Unexpected event!"),
6849                         }
6850                 } else {
6851                         panic!("Unexpected event")
6852                 }
6853         }
6854
6855         // Check we close channel detecting A is fallen-behind
6856         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6857         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
6858         check_added_monitors!(nodes[1], 1);
6859
6860
6861         // Check A is able to claim to_remote output
6862         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6863         assert_eq!(node_txn.len(), 1);
6864         check_spends!(node_txn[0], chan.3);
6865         assert_eq!(node_txn[0].output.len(), 2);
6866         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6867         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
6868         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
6869         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6870         assert_eq!(spend_txn.len(), 1);
6871         check_spends!(spend_txn[0], node_txn[0]);
6872 }
6873
6874 #[test]
6875 fn test_check_htlc_underpaying() {
6876         // Send payment through A -> B but A is maliciously
6877         // sending a probe payment (i.e less than expected value0
6878         // to B, B should refuse payment.
6879
6880         let chanmon_cfgs = create_chanmon_cfgs(2);
6881         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6882         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6883         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6884
6885         // Create some initial channels
6886         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6887
6888         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6889
6890         // Node 3 is expecting payment of 100_000 but receive 10_000,
6891         // fail htlc like we didn't know the preimage.
6892         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
6893         nodes[1].node.process_pending_htlc_forwards();
6894
6895         let events = nodes[1].node.get_and_clear_pending_msg_events();
6896         assert_eq!(events.len(), 1);
6897         let (update_fail_htlc, commitment_signed) = match events[0] {
6898                 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 } } => {
6899                         assert!(update_add_htlcs.is_empty());
6900                         assert!(update_fulfill_htlcs.is_empty());
6901                         assert_eq!(update_fail_htlcs.len(), 1);
6902                         assert!(update_fail_malformed_htlcs.is_empty());
6903                         assert!(update_fee.is_none());
6904                         (update_fail_htlcs[0].clone(), commitment_signed)
6905                 },
6906                 _ => panic!("Unexpected event"),
6907         };
6908         check_added_monitors!(nodes[1], 1);
6909
6910         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6911         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6912
6913         let events = nodes[0].node.get_and_clear_pending_events();
6914         assert_eq!(events.len(), 1);
6915         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6916                 assert_eq!(*rejected_by_dest, true);
6917                 assert_eq!(error_code.unwrap(), 0x4000|15);
6918         } else {
6919                 panic!("Unexpected event");
6920         }
6921         nodes[1].node.get_and_clear_pending_events();
6922 }
6923
6924 #[test]
6925 fn test_announce_disable_channels() {
6926         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6927         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6928
6929         let chanmon_cfgs = create_chanmon_cfgs(2);
6930         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6931         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6932         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6933
6934         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6935         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6936         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6937
6938         // Disconnect peers
6939         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6940         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6941
6942         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6943         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6944         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6945         assert_eq!(msg_events.len(), 3);
6946         for e in msg_events {
6947                 match e {
6948                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6949                                 let short_id = msg.contents.short_channel_id;
6950                                 // Check generated channel_update match list in PendingChannelUpdate
6951                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6952                                         panic!("Generated ChannelUpdate for wrong chan!");
6953                                 }
6954                         },
6955                         _ => panic!("Unexpected event"),
6956                 }
6957         }
6958         // Reconnect peers
6959         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6960         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6961         assert_eq!(reestablish_1.len(), 3);
6962         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6963         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6964         assert_eq!(reestablish_2.len(), 3);
6965
6966         // Reestablish chan_1
6967         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6968         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6969         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6970         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6971         // Reestablish chan_2
6972         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6973         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6974         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6975         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6976         // Reestablish chan_3
6977         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6978         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6979         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6980         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6981
6982         nodes[0].node.timer_chan_freshness_every_min();
6983         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6984 }
6985
6986 #[test]
6987 fn test_bump_penalty_txn_on_revoked_commitment() {
6988         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
6989         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
6990
6991         let chanmon_cfgs = create_chanmon_cfgs(2);
6992         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6993         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6994         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6995
6996         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
6997         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6998         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
6999         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7000
7001         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7002         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7003         assert_eq!(revoked_txn[0].output.len(), 4);
7004         assert_eq!(revoked_txn[0].input.len(), 1);
7005         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7006         let revoked_txid = revoked_txn[0].txid();
7007
7008         let mut penalty_sum = 0;
7009         for outp in revoked_txn[0].output.iter() {
7010                 if outp.script_pubkey.is_v0_p2wsh() {
7011                         penalty_sum += outp.value;
7012                 }
7013         }
7014
7015         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7016         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
7017
7018         // Actually revoke tx by claiming a HTLC
7019         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7020         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7021         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7022         check_added_monitors!(nodes[1], 1);
7023
7024         // One or more justice tx should have been broadcast, check it
7025         let penalty_1;
7026         let feerate_1;
7027         {
7028                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7029                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7030                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7031                 assert_eq!(node_txn[0].output.len(), 1);
7032                 check_spends!(node_txn[0], revoked_txn[0]);
7033                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7034                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7035                 penalty_1 = node_txn[0].txid();
7036                 node_txn.clear();
7037         };
7038
7039         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7040         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
7041         let mut penalty_2 = penalty_1;
7042         let mut feerate_2 = 0;
7043         {
7044                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7045                 assert_eq!(node_txn.len(), 1);
7046                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7047                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7048                         assert_eq!(node_txn[0].output.len(), 1);
7049                         check_spends!(node_txn[0], revoked_txn[0]);
7050                         penalty_2 = node_txn[0].txid();
7051                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7052                         assert_ne!(penalty_2, penalty_1);
7053                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7054                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7055                         // Verify 25% bump heuristic
7056                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7057                         node_txn.clear();
7058                 }
7059         }
7060         assert_ne!(feerate_2, 0);
7061
7062         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7063         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
7064         let penalty_3;
7065         let mut feerate_3 = 0;
7066         {
7067                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7068                 assert_eq!(node_txn.len(), 1);
7069                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7070                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7071                         assert_eq!(node_txn[0].output.len(), 1);
7072                         check_spends!(node_txn[0], revoked_txn[0]);
7073                         penalty_3 = node_txn[0].txid();
7074                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7075                         assert_ne!(penalty_3, penalty_2);
7076                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7077                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7078                         // Verify 25% bump heuristic
7079                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7080                         node_txn.clear();
7081                 }
7082         }
7083         assert_ne!(feerate_3, 0);
7084
7085         nodes[1].node.get_and_clear_pending_events();
7086         nodes[1].node.get_and_clear_pending_msg_events();
7087 }
7088
7089 #[test]
7090 fn test_bump_penalty_txn_on_revoked_htlcs() {
7091         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7092         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7093
7094         let chanmon_cfgs = create_chanmon_cfgs(2);
7095         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7096         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7097         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7098
7099         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7100         // Lock HTLC in both directions
7101         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7102         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7103
7104         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7105         assert_eq!(revoked_local_txn[0].input.len(), 1);
7106         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7107
7108         // Revoke local commitment tx
7109         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7110
7111         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7112         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7113         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7114         check_closed_broadcast!(nodes[1], false);
7115         check_added_monitors!(nodes[1], 1);
7116
7117         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7118         assert_eq!(revoked_htlc_txn.len(), 4);
7119         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7120                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7121                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7122                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7123                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7124                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7125         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7126                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7127                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7128                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7129                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7130                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7131         }
7132
7133         // Broadcast set of revoked txn on A
7134         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
7135         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7136         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
7137         let first;
7138         let feerate_1;
7139         let penalty_txn;
7140         {
7141                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7142                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7143                 // Verify claim tx are spending revoked HTLC txn
7144                 assert_eq!(node_txn[4].input.len(), 2);
7145                 assert_eq!(node_txn[4].output.len(), 1);
7146                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7147                 first = node_txn[4].txid();
7148                 // Store both feerates for later comparison
7149                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7150                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7151                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7152                 node_txn.clear();
7153         }
7154
7155         // Connect three more block to see if bumped penalty are issued for HTLC txn
7156         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7157         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7158         {
7159                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7160                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7161
7162                 check_spends!(node_txn[0], revoked_local_txn[0]);
7163                 check_spends!(node_txn[1], revoked_local_txn[0]);
7164
7165                 node_txn.clear();
7166         };
7167
7168         // Few more blocks to confirm penalty txn
7169         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
7170         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7171         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
7172         let node_txn = {
7173                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7174                 assert_eq!(node_txn.len(), 1);
7175
7176                 assert_eq!(node_txn[0].input.len(), 2);
7177                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7178                 // Verify bumped tx is different and 25% bump heuristic
7179                 assert_ne!(first, node_txn[0].txid());
7180                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7181                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7182                 assert!(feerate_2 * 100 > feerate_1 * 125);
7183                 let txn = vec![node_txn[0].clone()];
7184                 node_txn.clear();
7185                 txn
7186         };
7187         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7188         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7189         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
7190         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
7191         {
7192                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7193                 // We verify than no new transaction has been broadcast because previously
7194                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7195                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7196                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7197                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7198                 // up bumped justice generation.
7199                 assert_eq!(node_txn.len(), 0);
7200                 node_txn.clear();
7201         }
7202         check_closed_broadcast!(nodes[0], false);
7203         check_added_monitors!(nodes[0], 1);
7204 }
7205
7206 #[test]
7207 fn test_bump_penalty_txn_on_remote_commitment() {
7208         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7209         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7210
7211         // Create 2 HTLCs
7212         // Provide preimage for one
7213         // Check aggregation
7214
7215         let chanmon_cfgs = create_chanmon_cfgs(2);
7216         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7217         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7218         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7219
7220         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7221         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7222         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7223
7224         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7225         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7226         assert_eq!(remote_txn[0].output.len(), 4);
7227         assert_eq!(remote_txn[0].input.len(), 1);
7228         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7229
7230         // Claim a HTLC without revocation (provide B monitor with preimage)
7231         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7232         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7233         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7234         check_added_monitors!(nodes[1], 2);
7235
7236         // One or more claim tx should have been broadcast, check it
7237         let timeout;
7238         let preimage;
7239         let feerate_timeout;
7240         let feerate_preimage;
7241         {
7242                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7243                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7244                 assert_eq!(node_txn[0].input.len(), 1);
7245                 assert_eq!(node_txn[1].input.len(), 1);
7246                 check_spends!(node_txn[0], remote_txn[0]);
7247                 check_spends!(node_txn[1], remote_txn[0]);
7248                 check_spends!(node_txn[2], chan.3);
7249                 check_spends!(node_txn[3], node_txn[2]);
7250                 check_spends!(node_txn[4], node_txn[2]);
7251                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7252                         timeout = node_txn[0].txid();
7253                         let index = node_txn[0].input[0].previous_output.vout;
7254                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7255                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7256
7257                         preimage = node_txn[1].txid();
7258                         let index = node_txn[1].input[0].previous_output.vout;
7259                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7260                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7261                 } else {
7262                         timeout = node_txn[1].txid();
7263                         let index = node_txn[1].input[0].previous_output.vout;
7264                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7265                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7266
7267                         preimage = node_txn[0].txid();
7268                         let index = node_txn[0].input[0].previous_output.vout;
7269                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7270                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7271                 }
7272                 node_txn.clear();
7273         };
7274         assert_ne!(feerate_timeout, 0);
7275         assert_ne!(feerate_preimage, 0);
7276
7277         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7278         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
7279         {
7280                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7281                 assert_eq!(node_txn.len(), 2);
7282                 assert_eq!(node_txn[0].input.len(), 1);
7283                 assert_eq!(node_txn[1].input.len(), 1);
7284                 check_spends!(node_txn[0], remote_txn[0]);
7285                 check_spends!(node_txn[1], remote_txn[0]);
7286                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7287                         let index = node_txn[0].input[0].previous_output.vout;
7288                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7289                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7290                         assert!(new_feerate * 100 > feerate_timeout * 125);
7291                         assert_ne!(timeout, node_txn[0].txid());
7292
7293                         let index = node_txn[1].input[0].previous_output.vout;
7294                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7295                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7296                         assert!(new_feerate * 100 > feerate_preimage * 125);
7297                         assert_ne!(preimage, node_txn[1].txid());
7298                 } else {
7299                         let index = node_txn[1].input[0].previous_output.vout;
7300                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7301                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7302                         assert!(new_feerate * 100 > feerate_timeout * 125);
7303                         assert_ne!(timeout, node_txn[1].txid());
7304
7305                         let index = node_txn[0].input[0].previous_output.vout;
7306                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7307                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7308                         assert!(new_feerate * 100 > feerate_preimage * 125);
7309                         assert_ne!(preimage, node_txn[0].txid());
7310                 }
7311                 node_txn.clear();
7312         }
7313
7314         nodes[1].node.get_and_clear_pending_events();
7315         nodes[1].node.get_and_clear_pending_msg_events();
7316 }
7317
7318 #[test]
7319 fn test_set_outpoints_partial_claiming() {
7320         // - remote party claim tx, new bump tx
7321         // - disconnect remote claiming tx, new bump
7322         // - disconnect tx, see no tx anymore
7323         let chanmon_cfgs = create_chanmon_cfgs(2);
7324         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7325         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7326         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7327
7328         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7329         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7330         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7331
7332         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7333         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
7334         assert_eq!(remote_txn.len(), 3);
7335         assert_eq!(remote_txn[0].output.len(), 4);
7336         assert_eq!(remote_txn[0].input.len(), 1);
7337         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7338         check_spends!(remote_txn[1], remote_txn[0]);
7339         check_spends!(remote_txn[2], remote_txn[0]);
7340
7341         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7342         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
7343         // Provide node A with both preimage
7344         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
7345         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
7346         check_added_monitors!(nodes[0], 2);
7347         nodes[0].node.get_and_clear_pending_events();
7348         nodes[0].node.get_and_clear_pending_msg_events();
7349
7350         // Connect blocks on node A commitment transaction
7351         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7352         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7353         check_closed_broadcast!(nodes[0], false);
7354         check_added_monitors!(nodes[0], 1);
7355         // Verify node A broadcast tx claiming both HTLCs
7356         {
7357                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7358                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7359                 assert_eq!(node_txn.len(), 4);
7360                 check_spends!(node_txn[0], remote_txn[0]);
7361                 check_spends!(node_txn[1], chan.3);
7362                 check_spends!(node_txn[2], node_txn[1]);
7363                 check_spends!(node_txn[3], node_txn[1]);
7364                 assert_eq!(node_txn[0].input.len(), 2);
7365                 node_txn.clear();
7366         }
7367
7368         // Connect blocks on node B
7369         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
7370         check_closed_broadcast!(nodes[1], false);
7371         check_added_monitors!(nodes[1], 1);
7372         // Verify node B broadcast 2 HTLC-timeout txn
7373         let partial_claim_tx = {
7374                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7375                 assert_eq!(node_txn.len(), 3);
7376                 check_spends!(node_txn[1], node_txn[0]);
7377                 check_spends!(node_txn[2], node_txn[0]);
7378                 assert_eq!(node_txn[1].input.len(), 1);
7379                 assert_eq!(node_txn[2].input.len(), 1);
7380                 node_txn[1].clone()
7381         };
7382
7383         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7384         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7385         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7386         {
7387                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7388                 assert_eq!(node_txn.len(), 1);
7389                 check_spends!(node_txn[0], remote_txn[0]);
7390                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7391                 node_txn.clear();
7392         }
7393         nodes[0].node.get_and_clear_pending_msg_events();
7394
7395         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7396         nodes[0].block_notifier.block_disconnected(&header, 102);
7397         {
7398                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7399                 assert_eq!(node_txn.len(), 1);
7400                 check_spends!(node_txn[0], remote_txn[0]);
7401                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7402                 node_txn.clear();
7403         }
7404
7405         //// Disconnect one more block and then reconnect multiple no transaction should be generated
7406         nodes[0].block_notifier.block_disconnected(&header, 101);
7407         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7408         {
7409                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7410                 assert_eq!(node_txn.len(), 0);
7411                 node_txn.clear();
7412         }
7413 }
7414
7415 #[test]
7416 fn test_counterparty_raa_skip_no_crash() {
7417         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7418         // commitment transaction, we would have happily carried on and provided them the next
7419         // commitment transaction based on one RAA forward. This would probably eventually have led to
7420         // channel closure, but it would not have resulted in funds loss. Still, our
7421         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7422         // check simply that the channel is closed in response to such an RAA, but don't check whether
7423         // we decide to punish our counterparty for revoking their funds (as we don't currently
7424         // implement that).
7425         let chanmon_cfgs = create_chanmon_cfgs(2);
7426         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7427         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7428         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7429         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).2;
7430
7431         let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7432         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7433         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7434                 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7435         let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7436
7437         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7438                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7439         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7440         check_added_monitors!(nodes[1], 1);
7441 }
7442
7443 #[test]
7444 fn test_bump_txn_sanitize_tracking_maps() {
7445         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7446         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7447
7448         let chanmon_cfgs = create_chanmon_cfgs(2);
7449         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7450         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7451         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7452
7453         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7454         // Lock HTLC in both directions
7455         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7456         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7457
7458         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7459         assert_eq!(revoked_local_txn[0].input.len(), 1);
7460         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7461
7462         // Revoke local commitment tx
7463         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7464
7465         // Broadcast set of revoked txn on A
7466         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
7467         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7468         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7469         check_closed_broadcast!(nodes[0], false);
7470         check_added_monitors!(nodes[0], 1);
7471         let penalty_txn = {
7472                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7473                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7474                 check_spends!(node_txn[0], revoked_local_txn[0]);
7475                 check_spends!(node_txn[1], revoked_local_txn[0]);
7476                 check_spends!(node_txn[2], revoked_local_txn[0]);
7477                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7478                 node_txn.clear();
7479                 penalty_txn
7480         };
7481         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7482         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7483         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
7484         {
7485                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7486                 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7487                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
7488                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
7489                 }
7490         }
7491 }
7492
7493 #[test]
7494 fn test_override_channel_config() {
7495         let chanmon_cfgs = create_chanmon_cfgs(2);
7496         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7497         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7498         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7499
7500         // Node0 initiates a channel to node1 using the override config.
7501         let mut override_config = UserConfig::default();
7502         override_config.own_channel_config.our_to_self_delay = 200;
7503
7504         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
7505
7506         // Assert the channel created by node0 is using the override config.
7507         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7508         assert_eq!(res.channel_flags, 0);
7509         assert_eq!(res.to_self_delay, 200);
7510 }
7511
7512 #[test]
7513 fn test_override_0msat_htlc_minimum() {
7514         let mut zero_config = UserConfig::default();
7515         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
7516         let chanmon_cfgs = create_chanmon_cfgs(2);
7517         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7518         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7519         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7520
7521         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
7522         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7523         assert_eq!(res.htlc_minimum_msat, 1);
7524
7525         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &res);
7526         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7527         assert_eq!(res.htlc_minimum_msat, 1);
7528 }
7529
7530 #[test]
7531 fn test_simple_payment_secret() {
7532         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
7533         // features, however.
7534         let chanmon_cfgs = create_chanmon_cfgs(3);
7535         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7536         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7537         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7538
7539         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
7540         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
7541
7542         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7543         let payment_secret = PaymentSecret([0xdb; 32]);
7544         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7545         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
7546         // Claiming with all the correct values but the wrong secret should result in nothing...
7547         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
7548         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
7549         // ...but with the right secret we should be able to claim all the way back
7550         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
7551 }
7552
7553 #[test]
7554 fn test_simple_mpp() {
7555         // Simple test of sending a multi-path payment.
7556         let chanmon_cfgs = create_chanmon_cfgs(4);
7557         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7558         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7559         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7560
7561         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7562         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7563         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7564         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7565
7566         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7567         let payment_secret = PaymentSecret([0xdb; 32]);
7568         let mut route = nodes[0].router.get_route(&nodes[3].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7569         let path = route.paths[0].clone();
7570         route.paths.push(path);
7571         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7572         route.paths[0][0].short_channel_id = chan_1_id;
7573         route.paths[0][1].short_channel_id = chan_3_id;
7574         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7575         route.paths[1][0].short_channel_id = chan_2_id;
7576         route.paths[1][1].short_channel_id = chan_4_id;
7577         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
7578         // Claiming with all the correct values but the wrong secret should result in nothing...
7579         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
7580         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
7581         // ...but with the right secret we should be able to claim all the way back
7582         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
7583 }