_ Git - rust-lightning/blob - lightning/src/ln/functional_tests.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
  11 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
  12 //! claim outputs on-chain.
  13
  14 use chain;
  15 use chain::Listen;
  16 use chain::Watch;
  17 use chain::channelmonitor;
  18 use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
  19 use chain::transaction::OutPoint;
  20 use chain::keysinterface::{KeysInterface, BaseSign};
  21 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  22 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentSecret, PaymentHash, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  23 use ln::channel::{Channel, ChannelError};
  24 use ln::{chan_utils, onion_utils};
  25 use routing::router::{Route, RouteHop, get_route};
  26 use ln::features::{ChannelFeatures, InitFeatures, InvoiceFeatures, NodeFeatures};
  27 use ln::msgs;
  28 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  29 use util::enforcing_trait_impls::EnforcingSigner;
  30 use util::{byte_utils, test_utils};
  31 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  32 use util::errors::APIError;
  33 use util::ser::{Writeable, ReadableArgs};
  34 use util::config::UserConfig;
  35
  36 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  37 use bitcoin::hash_types::{Txid, BlockHash};
  38 use bitcoin::blockdata::block::{Block, BlockHeader};
  39 use bitcoin::blockdata::script::Builder;
  40 use bitcoin::blockdata::opcodes;
  41 use bitcoin::blockdata::constants::genesis_block;
  42 use bitcoin::network::constants::Network;
  43
  44 use bitcoin::hashes::sha256::Hash as Sha256;
  45 use bitcoin::hashes::Hash;
  46
  47 use bitcoin::secp256k1::{Secp256k1, Message};
  48 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  49
  50 use regex;
  51
  52 use std::collections::{BTreeSet, HashMap, HashSet};
  53 use std::default::Default;
  54 use std::sync::Mutex;
  55
  56 use ln::functional_test_utils::*;
  57 use ln::chan_utils::CommitmentTransaction;
  58 use ln::msgs::OptionalField::Present;
  59
  60 #[test]
  61 fn test_insane_channel_opens() {
  62         // Stand up a network of 2 nodes
  63         let chanmon_cfgs = create_chanmon_cfgs(2);
  64         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  65         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  66         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  67
  68         // Instantiate channel parameters where we push the maximum msats given our
  69         // funding satoshis
  70         let channel_value_sat = 31337; // same as funding satoshis
  71         let channel_reserve_satoshis = Channel::<EnforcingSigner>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  72         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  73
  74         // Have node0 initiate a channel to node1 with aforementioned parameters
  75         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  76
  77         // Extract the channel open message from node0 to node1
  78         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  79
  80         // Test helper that asserts we get the correct error string given a mutator
  81         // that supposedly makes the channel open message insane
  82         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  83                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  84                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  85                 assert_eq!(msg_events.len(), 1);
  86                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  87                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  88                         match action {
  89                                 &ErrorAction::SendErrorMessage { .. } => {
  90                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  91                                 },
  92                                 _ => panic!("unexpected event!"),
  93                         }
  94                 } else { assert!(false); }
  95         };
  96
  97         use ln::channel::MAX_FUNDING_SATOSHIS;
  98         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
  99
 100         // Test all mutations that would make the channel open message insane
 101         insane_open_helper(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, MAX_FUNDING_SATOSHIS).as_str(), |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
 102
 103         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 104
 105         insane_open_helper(r"push_msat \d+ was larger than funding value \d+", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
 106
 107         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 108
 109         insane_open_helper(r"Bogus; channel reserve \(\d+\) is less than dust limit \(\d+\)", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 110
 111         insane_open_helper(r"Minimum htlc value \(\d+\) was larger than full channel value \(\d+\)", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
 112
 113         insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
 114
 115         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 116
 117         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 118 }
 119
 120 #[test]
 121 fn test_async_inbound_update_fee() {
 122         let chanmon_cfgs = create_chanmon_cfgs(2);
 123         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 124         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 125         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 126         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 127         let logger = test_utils::TestLogger::new();
 128         let channel_id = chan.2;
 129
 130         // balancing
 131         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 132
 133         // A                                        B
 134         // update_fee                            ->
 135         // send (1) commitment_signed            -.
 136         //                                       <- update_add_htlc/commitment_signed
 137         // send (2) RAA (awaiting remote revoke) -.
 138         // (1) commitment_signed is delivered    ->
 139         //                                       .- send (3) RAA (awaiting remote revoke)
 140         // (2) RAA is delivered                  ->
 141         //                                       .- send (4) commitment_signed
 142         //                                       <- (3) RAA is delivered
 143         // send (5) commitment_signed            -.
 144         //                                       <- (4) commitment_signed is delivered
 145         // send (6) RAA                          -.
 146         // (5) commitment_signed is delivered    ->
 147         //                                       <- RAA
 148         // (6) RAA is delivered                  ->
 149
 150         // First nodes[0] generates an update_fee
 151         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 152         check_added_monitors!(nodes[0], 1);
 153
 154         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 155         assert_eq!(events_0.len(), 1);
 156         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 157                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 158                         (update_fee.as_ref(), commitment_signed)
 159                 },
 160                 _ => panic!("Unexpected event"),
 161         };
 162
 163         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 164
 165         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 166         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 167         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 168         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
 169         check_added_monitors!(nodes[1], 1);
 170
 171         let payment_event = {
 172                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 173                 assert_eq!(events_1.len(), 1);
 174                 SendEvent::from_event(events_1.remove(0))
 175         };
 176         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 177         assert_eq!(payment_event.msgs.len(), 1);
 178
 179         // ...now when the messages get delivered everyone should be happy
 180         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 181         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 182         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 183         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 184         check_added_monitors!(nodes[0], 1);
 185
 186         // deliver(1), generate (3):
 187         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 188         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 189         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 190         check_added_monitors!(nodes[1], 1);
 191
 192         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 193         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 194         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 195         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 196         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 197         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 198         assert!(bs_update.update_fee.is_none()); // (4)
 199         check_added_monitors!(nodes[1], 1);
 200
 201         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 202         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 203         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 204         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 205         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 206         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 207         assert!(as_update.update_fee.is_none()); // (5)
 208         check_added_monitors!(nodes[0], 1);
 209
 210         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 211         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 212         // only (6) so get_event_msg's assert(len == 1) passes
 213         check_added_monitors!(nodes[0], 1);
 214
 215         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 216         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 217         check_added_monitors!(nodes[1], 1);
 218
 219         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 220         check_added_monitors!(nodes[0], 1);
 221
 222         let events_2 = nodes[0].node.get_and_clear_pending_events();
 223         assert_eq!(events_2.len(), 1);
 224         match events_2[0] {
 225                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 226                 _ => panic!("Unexpected event"),
 227         }
 228
 229         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 230         check_added_monitors!(nodes[1], 1);
 231 }
 232
 233 #[test]
 234 fn test_update_fee_unordered_raa() {
 235         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 236         // crash in an earlier version of the update_fee patch)
 237         let chanmon_cfgs = create_chanmon_cfgs(2);
 238         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 239         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 240         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 241         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 242         let channel_id = chan.2;
 243         let logger = test_utils::TestLogger::new();
 244
 245         // balancing
 246         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 247
 248         // First nodes[0] generates an update_fee
 249         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 250         check_added_monitors!(nodes[0], 1);
 251
 252         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 253         assert_eq!(events_0.len(), 1);
 254         let update_msg = match events_0[0] { // (1)
 255                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 256                         update_fee.as_ref()
 257                 },
 258                 _ => panic!("Unexpected event"),
 259         };
 260
 261         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 262
 263         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 264         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 265         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 266         nodes[1].node.send_payment(&get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &Some(our_payment_secret)).unwrap();
 267         check_added_monitors!(nodes[1], 1);
 268
 269         let payment_event = {
 270                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 271                 assert_eq!(events_1.len(), 1);
 272                 SendEvent::from_event(events_1.remove(0))
 273         };
 274         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 275         assert_eq!(payment_event.msgs.len(), 1);
 276
 277         // ...now when the messages get delivered everyone should be happy
 278         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 279         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 280         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 281         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 282         check_added_monitors!(nodes[0], 1);
 283
 284         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 285         check_added_monitors!(nodes[1], 1);
 286
 287         // We can't continue, sadly, because our (1) now has a bogus signature
 288 }
 289
 290 #[test]
 291 fn test_multi_flight_update_fee() {
 292         let chanmon_cfgs = create_chanmon_cfgs(2);
 293         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 294         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 295         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 296         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 297         let channel_id = chan.2;
 298
 299         // A                                        B
 300         // update_fee/commitment_signed          ->
 301         //                                       .- send (1) RAA and (2) commitment_signed
 302         // update_fee (never committed)          ->
 303         // (3) update_fee                        ->
 304         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 305         // don't track which updates correspond to which revoke_and_ack responses so we're in
 306         // AwaitingRAA mode and will not generate the update_fee yet.
 307         //                                       <- (1) RAA delivered
 308         // (3) is generated and send (4) CS      -.
 309         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 310         // know the per_commitment_point to use for it.
 311         //                                       <- (2) commitment_signed delivered
 312         // revoke_and_ack                        ->
 313         //                                          B should send no response here
 314         // (4) commitment_signed delivered       ->
 315         //                                       <- RAA/commitment_signed delivered
 316         // revoke_and_ack                        ->
 317
 318         // First nodes[0] generates an update_fee
 319         let initial_feerate = get_feerate!(nodes[0], channel_id);
 320         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 321         check_added_monitors!(nodes[0], 1);
 322
 323         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 324         assert_eq!(events_0.len(), 1);
 325         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 326                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 327                         (update_fee.as_ref().unwrap(), commitment_signed)
 328                 },
 329                 _ => panic!("Unexpected event"),
 330         };
 331
 332         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 333         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 334         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 335         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 336         check_added_monitors!(nodes[1], 1);
 337
 338         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 339         // transaction:
 340         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 341         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 342         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 343
 344         // Create the (3) update_fee message that nodes[0] will generate before it does...
 345         let mut update_msg_2 = msgs::UpdateFee {
 346                 channel_id: update_msg_1.channel_id.clone(),
 347                 feerate_per_kw: (initial_feerate + 30) as u32,
 348         };
 349
 350         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 351
 352         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 353         // Deliver (3)
 354         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 355
 356         // Deliver (1), generating (3) and (4)
 357         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 358         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 359         check_added_monitors!(nodes[0], 1);
 360         assert!(as_second_update.update_add_htlcs.is_empty());
 361         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 362         assert!(as_second_update.update_fail_htlcs.is_empty());
 363         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 364         // Check that the update_fee newly generated matches what we delivered:
 365         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 366         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 367
 368         // Deliver (2) commitment_signed
 369         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 370         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 371         check_added_monitors!(nodes[0], 1);
 372         // No commitment_signed so get_event_msg's assert(len == 1) passes
 373
 374         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 375         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 376         check_added_monitors!(nodes[1], 1);
 377
 378         // Delever (4)
 379         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 380         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 381         check_added_monitors!(nodes[1], 1);
 382
 383         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 384         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 385         check_added_monitors!(nodes[0], 1);
 386
 387         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 388         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 389         // No commitment_signed so get_event_msg's assert(len == 1) passes
 390         check_added_monitors!(nodes[0], 1);
 391
 392         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 393         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 394         check_added_monitors!(nodes[1], 1);
 395 }
 396
 397 fn do_test_1_conf_open(connect_style: ConnectStyle) {
 398         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 399         // tests that we properly send one in that case.
 400         let mut alice_config = UserConfig::default();
 401         alice_config.own_channel_config.minimum_depth = 1;
 402         alice_config.channel_options.announced_channel = true;
 403         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 404         let mut bob_config = UserConfig::default();
 405         bob_config.own_channel_config.minimum_depth = 1;
 406         bob_config.channel_options.announced_channel = true;
 407         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 408         let chanmon_cfgs = create_chanmon_cfgs(2);
 409         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 410         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 411         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 412         *nodes[0].connect_style.borrow_mut() = connect_style;
 413
 414         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 415         mine_transaction(&nodes[1], &tx);
 416         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
 417
 418         mine_transaction(&nodes[0], &tx);
 419         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 420         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 421
 422         for node in nodes {
 423                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 424                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 425                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 426         }
 427 }
 428 #[test]
 429 fn test_1_conf_open() {
 430         do_test_1_conf_open(ConnectStyle::BestBlockFirst);
 431         do_test_1_conf_open(ConnectStyle::TransactionsFirst);
 432         do_test_1_conf_open(ConnectStyle::FullBlockViaListen);
 433 }
 434
 435 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 436         // Previously, we had issues deserializing channels when we hadn't connected the first block
 437         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 438         // serialization round-trips and simply do steps towards opening a channel and then drop the
 439         // Node objects.
 440
 441         let chanmon_cfgs = create_chanmon_cfgs(2);
 442         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 443         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 444         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 445
 446         if steps & 0b1000_0000 != 0{
 447                 let block = Block {
 448                         header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 449                         txdata: vec![],
 450                 };
 451                 connect_block(&nodes[0], &block);
 452                 connect_block(&nodes[1], &block);
 453         }
 454
 455         if steps & 0x0f == 0 { return; }
 456         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 457         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 458
 459         if steps & 0x0f == 1 { return; }
 460         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 461         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 462
 463         if steps & 0x0f == 2 { return; }
 464         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 465
 466         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 467
 468         if steps & 0x0f == 3 { return; }
 469         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 470         check_added_monitors!(nodes[0], 0);
 471         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 472
 473         if steps & 0x0f == 4 { return; }
 474         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 475         {
 476                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 477                 assert_eq!(added_monitors.len(), 1);
 478                 assert_eq!(added_monitors[0].0, funding_output);
 479                 added_monitors.clear();
 480         }
 481         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 482
 483         if steps & 0x0f == 5 { return; }
 484         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 485         {
 486                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 487                 assert_eq!(added_monitors.len(), 1);
 488                 assert_eq!(added_monitors[0].0, funding_output);
 489                 added_monitors.clear();
 490         }
 491
 492         let events_4 = nodes[0].node.get_and_clear_pending_events();
 493         assert_eq!(events_4.len(), 0);
 494
 495         if steps & 0x0f == 6 { return; }
 496         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx, 2);
 497
 498         if steps & 0x0f == 7 { return; }
 499         confirm_transaction_at(&nodes[0], &tx, 2);
 500         connect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH);
 501         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 502 }
 503
 504 #[test]
 505 fn test_sanity_on_in_flight_opens() {
 506         do_test_sanity_on_in_flight_opens(0);
 507         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 508         do_test_sanity_on_in_flight_opens(1);
 509         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 510         do_test_sanity_on_in_flight_opens(2);
 511         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 512         do_test_sanity_on_in_flight_opens(3);
 513         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 514         do_test_sanity_on_in_flight_opens(4);
 515         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 516         do_test_sanity_on_in_flight_opens(5);
 517         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 518         do_test_sanity_on_in_flight_opens(6);
 519         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 520         do_test_sanity_on_in_flight_opens(7);
 521         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 522         do_test_sanity_on_in_flight_opens(8);
 523         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 524 }
 525
 526 #[test]
 527 fn test_update_fee_vanilla() {
 528         let chanmon_cfgs = create_chanmon_cfgs(2);
 529         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 530         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 531         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 532         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 533         let channel_id = chan.2;
 534
 535         let feerate = get_feerate!(nodes[0], channel_id);
 536         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 537         check_added_monitors!(nodes[0], 1);
 538
 539         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 540         assert_eq!(events_0.len(), 1);
 541         let (update_msg, commitment_signed) = match events_0[0] {
 542                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 543                         (update_fee.as_ref(), commitment_signed)
 544                 },
 545                 _ => panic!("Unexpected event"),
 546         };
 547         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 548
 549         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 550         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 551         check_added_monitors!(nodes[1], 1);
 552
 553         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 554         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 555         check_added_monitors!(nodes[0], 1);
 556
 557         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 558         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 559         // No commitment_signed so get_event_msg's assert(len == 1) passes
 560         check_added_monitors!(nodes[0], 1);
 561
 562         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 563         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 564         check_added_monitors!(nodes[1], 1);
 565 }
 566
 567 #[test]
 568 fn test_update_fee_that_funder_cannot_afford() {
 569         let chanmon_cfgs = create_chanmon_cfgs(2);
 570         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 571         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 572         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 573         let channel_value = 1888;
 574         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 575         let channel_id = chan.2;
 576
 577         let feerate = 260;
 578         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 579         check_added_monitors!(nodes[0], 1);
 580         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 581
 582         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 583
 584         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 585
 586         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 587         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 588         {
 589                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 590
 591                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 592                 let num_htlcs = commitment_tx.output.len() - 2;
 593                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 594                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 595                 actual_fee = channel_value - actual_fee;
 596                 assert_eq!(total_fee, actual_fee);
 597         }
 598
 599         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 600         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 601         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 602         check_added_monitors!(nodes[0], 1);
 603
 604         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 605
 606         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 607
 608         //While producing the commitment_signed response after handling a received update_fee request the
 609         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 610         //Should produce and error.
 611         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 612         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 613         check_added_monitors!(nodes[1], 1);
 614         check_closed_broadcast!(nodes[1], true);
 615 }
 616
 617 #[test]
 618 fn test_update_fee_with_fundee_update_add_htlc() {
 619         let chanmon_cfgs = create_chanmon_cfgs(2);
 620         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 621         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 622         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 623         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 624         let channel_id = chan.2;
 625         let logger = test_utils::TestLogger::new();
 626
 627         // balancing
 628         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
 629
 630         let feerate = get_feerate!(nodes[0], channel_id);
 631         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 632         check_added_monitors!(nodes[0], 1);
 633
 634         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 635         assert_eq!(events_0.len(), 1);
 636         let (update_msg, commitment_signed) = match events_0[0] {
 637                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 638                         (update_fee.as_ref(), commitment_signed)
 639                 },
 640                 _ => panic!("Unexpected event"),
 641         };
 642         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 643         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 644         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 645         check_added_monitors!(nodes[1], 1);
 646
 647         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[0]);
 648         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 649         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
 650
 651         // nothing happens since node[1] is in AwaitingRemoteRevoke
 652         nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 653         {
 654                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 655                 assert_eq!(added_monitors.len(), 0);
 656                 added_monitors.clear();
 657         }
 658         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 659         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 660         // node[1] has nothing to do
 661
 662         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 663         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 664         check_added_monitors!(nodes[0], 1);
 665
 666         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 667         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 668         // No commitment_signed so get_event_msg's assert(len == 1) passes
 669         check_added_monitors!(nodes[0], 1);
 670         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 671         check_added_monitors!(nodes[1], 1);
 672         // AwaitingRemoteRevoke ends here
 673
 674         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 675         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 676         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 677         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 678         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 679         assert_eq!(commitment_update.update_fee.is_none(), true);
 680
 681         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 682         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 683         check_added_monitors!(nodes[0], 1);
 684         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 685
 686         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 687         check_added_monitors!(nodes[1], 1);
 688         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 689
 690         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 691         check_added_monitors!(nodes[1], 1);
 692         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 693         // No commitment_signed so get_event_msg's assert(len == 1) passes
 694
 695         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 696         check_added_monitors!(nodes[0], 1);
 697         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 698
 699         expect_pending_htlcs_forwardable!(nodes[0]);
 700
 701         let events = nodes[0].node.get_and_clear_pending_events();
 702         assert_eq!(events.len(), 1);
 703         match events[0] {
 704                 Event::PaymentReceived { .. } => { },
 705                 _ => panic!("Unexpected event"),
 706         };
 707
 708         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
 709
 710         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
 711         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
 712         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 713 }
 714
 715 #[test]
 716 fn test_update_fee() {
 717         let chanmon_cfgs = create_chanmon_cfgs(2);
 718         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 719         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 720         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 721         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 722         let channel_id = chan.2;
 723
 724         // A                                        B
 725         // (1) update_fee/commitment_signed      ->
 726         //                                       <- (2) revoke_and_ack
 727         //                                       .- send (3) commitment_signed
 728         // (4) update_fee/commitment_signed      ->
 729         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 730         //                                       <- (3) commitment_signed delivered
 731         // send (6) revoke_and_ack               -.
 732         //                                       <- (5) deliver revoke_and_ack
 733         // (6) deliver revoke_and_ack            ->
 734         //                                       .- send (7) commitment_signed in response to (4)
 735         //                                       <- (7) deliver commitment_signed
 736         // revoke_and_ack                        ->
 737
 738         // Create and deliver (1)...
 739         let feerate = get_feerate!(nodes[0], channel_id);
 740         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 741         check_added_monitors!(nodes[0], 1);
 742
 743         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 744         assert_eq!(events_0.len(), 1);
 745         let (update_msg, commitment_signed) = match events_0[0] {
 746                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 747                         (update_fee.as_ref(), commitment_signed)
 748                 },
 749                 _ => panic!("Unexpected event"),
 750         };
 751         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 752
 753         // Generate (2) and (3):
 754         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 755         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 756         check_added_monitors!(nodes[1], 1);
 757
 758         // Deliver (2):
 759         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 760         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 761         check_added_monitors!(nodes[0], 1);
 762
 763         // Create and deliver (4)...
 764         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 765         check_added_monitors!(nodes[0], 1);
 766         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 767         assert_eq!(events_0.len(), 1);
 768         let (update_msg, commitment_signed) = match events_0[0] {
 769                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 770                         (update_fee.as_ref(), commitment_signed)
 771                 },
 772                 _ => panic!("Unexpected event"),
 773         };
 774
 775         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 776         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 777         check_added_monitors!(nodes[1], 1);
 778         // ... creating (5)
 779         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 780         // No commitment_signed so get_event_msg's assert(len == 1) passes
 781
 782         // Handle (3), creating (6):
 783         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 784         check_added_monitors!(nodes[0], 1);
 785         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 786         // No commitment_signed so get_event_msg's assert(len == 1) passes
 787
 788         // Deliver (5):
 789         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 790         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 791         check_added_monitors!(nodes[0], 1);
 792
 793         // Deliver (6), creating (7):
 794         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 795         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 796         assert!(commitment_update.update_add_htlcs.is_empty());
 797         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 798         assert!(commitment_update.update_fail_htlcs.is_empty());
 799         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 800         assert!(commitment_update.update_fee.is_none());
 801         check_added_monitors!(nodes[1], 1);
 802
 803         // Deliver (7)
 804         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 805         check_added_monitors!(nodes[0], 1);
 806         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 807         // No commitment_signed so get_event_msg's assert(len == 1) passes
 808
 809         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 810         check_added_monitors!(nodes[1], 1);
 811         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 812
 813         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 814         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 815         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 816 }
 817
 818 #[test]
 819 fn pre_funding_lock_shutdown_test() {
 820         // Test sending a shutdown prior to funding_locked after funding generation
 821         let chanmon_cfgs = create_chanmon_cfgs(2);
 822         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 823         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 824         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 825         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 826         mine_transaction(&nodes[0], &tx);
 827         mine_transaction(&nodes[1], &tx);
 828
 829         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 830         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 831         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 832         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 833         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 834
 835         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 836         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 837         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 838         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 839         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 840         assert!(node_0_none.is_none());
 841
 842         assert!(nodes[0].node.list_channels().is_empty());
 843         assert!(nodes[1].node.list_channels().is_empty());
 844 }
 845
 846 #[test]
 847 fn updates_shutdown_wait() {
 848         // Test sending a shutdown with outstanding updates pending
 849         let chanmon_cfgs = create_chanmon_cfgs(3);
 850         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 851         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 852         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 853         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 854         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 855         let logger = test_utils::TestLogger::new();
 856
 857         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 858
 859         nodes[0].node.close_channel(&chan_1.2).unwrap();
 860         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 861         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 862         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 863         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 864
 865         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 866         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 867
 868         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
 869
 870         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 871         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 872         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 873         let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 874         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 875         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &Some(payment_secret)), true, APIError::ChannelUnavailable {..}, {});
 876
 877         assert!(nodes[2].node.claim_funds(our_payment_preimage));
 878         check_added_monitors!(nodes[2], 1);
 879         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 880         assert!(updates.update_add_htlcs.is_empty());
 881         assert!(updates.update_fail_htlcs.is_empty());
 882         assert!(updates.update_fail_malformed_htlcs.is_empty());
 883         assert!(updates.update_fee.is_none());
 884         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 885         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 886         check_added_monitors!(nodes[1], 1);
 887         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 888         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 889
 890         assert!(updates_2.update_add_htlcs.is_empty());
 891         assert!(updates_2.update_fail_htlcs.is_empty());
 892         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 893         assert!(updates_2.update_fee.is_none());
 894         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 895         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 896         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 897
 898         let events = nodes[0].node.get_and_clear_pending_events();
 899         assert_eq!(events.len(), 1);
 900         match events[0] {
 901                 Event::PaymentSent { ref payment_preimage } => {
 902                         assert_eq!(our_payment_preimage, *payment_preimage);
 903                 },
 904                 _ => panic!("Unexpected event"),
 905         }
 906
 907         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 908         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 909         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 910         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 911         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 912         assert!(node_0_none.is_none());
 913
 914         assert!(nodes[0].node.list_channels().is_empty());
 915
 916         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 917         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 918         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 919         assert!(nodes[1].node.list_channels().is_empty());
 920         assert!(nodes[2].node.list_channels().is_empty());
 921 }
 922
 923 #[test]
 924 fn htlc_fail_async_shutdown() {
 925         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 926         let chanmon_cfgs = create_chanmon_cfgs(3);
 927         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 928         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 929         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 930         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 931         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 932         let logger = test_utils::TestLogger::new();
 933
 934         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
 935         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 936         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 937         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
 938         check_added_monitors!(nodes[0], 1);
 939         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 940         assert_eq!(updates.update_add_htlcs.len(), 1);
 941         assert!(updates.update_fulfill_htlcs.is_empty());
 942         assert!(updates.update_fail_htlcs.is_empty());
 943         assert!(updates.update_fail_malformed_htlcs.is_empty());
 944         assert!(updates.update_fee.is_none());
 945
 946         nodes[1].node.close_channel(&chan_1.2).unwrap();
 947         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 948         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
 949         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 950
 951         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 952         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 953         check_added_monitors!(nodes[1], 1);
 954         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
 955         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 956
 957         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 958         assert!(updates_2.update_add_htlcs.is_empty());
 959         assert!(updates_2.update_fulfill_htlcs.is_empty());
 960         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 961         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 962         assert!(updates_2.update_fee.is_none());
 963
 964         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 965         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 966
 967         expect_payment_failed!(nodes[0], our_payment_hash, false);
 968
 969         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 970         assert_eq!(msg_events.len(), 2);
 971         let node_0_closing_signed = match msg_events[0] {
 972                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 973                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 974                         (*msg).clone()
 975                 },
 976                 _ => panic!("Unexpected event"),
 977         };
 978         match msg_events[1] {
 979                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 980                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 981                 },
 982                 _ => panic!("Unexpected event"),
 983         }
 984
 985         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 986         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 987         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 988         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 989         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 990         assert!(node_0_none.is_none());
 991
 992         assert!(nodes[0].node.list_channels().is_empty());
 993
 994         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 995         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 996         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 997         assert!(nodes[1].node.list_channels().is_empty());
 998         assert!(nodes[2].node.list_channels().is_empty());
 999 }
1000
1001 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1002         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1003         // messages delivered prior to disconnect
1004         let chanmon_cfgs = create_chanmon_cfgs(3);
1005         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1006         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1007         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1008         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1009         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1010
1011         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1012
1013         nodes[1].node.close_channel(&chan_1.2).unwrap();
1014         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1015         if recv_count > 0 {
1016                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
1017                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1018                 if recv_count > 1 {
1019                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
1020                 }
1021         }
1022
1023         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1024         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1025
1026         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1027         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1028         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1029         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1030
1031         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1032         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1033         assert!(node_1_shutdown == node_1_2nd_shutdown);
1034
1035         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1036         let node_0_2nd_shutdown = if recv_count > 0 {
1037                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1038                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1039                 node_0_2nd_shutdown
1040         } else {
1041                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1042                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_2nd_shutdown);
1043                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1044         };
1045         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_2nd_shutdown);
1046
1047         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1048         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1049
1050         assert!(nodes[2].node.claim_funds(our_payment_preimage));
1051         check_added_monitors!(nodes[2], 1);
1052         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1053         assert!(updates.update_add_htlcs.is_empty());
1054         assert!(updates.update_fail_htlcs.is_empty());
1055         assert!(updates.update_fail_malformed_htlcs.is_empty());
1056         assert!(updates.update_fee.is_none());
1057         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1058         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1059         check_added_monitors!(nodes[1], 1);
1060         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1061         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1062
1063         assert!(updates_2.update_add_htlcs.is_empty());
1064         assert!(updates_2.update_fail_htlcs.is_empty());
1065         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1066         assert!(updates_2.update_fee.is_none());
1067         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1068         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1069         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1070
1071         let events = nodes[0].node.get_and_clear_pending_events();
1072         assert_eq!(events.len(), 1);
1073         match events[0] {
1074                 Event::PaymentSent { ref payment_preimage } => {
1075                         assert_eq!(our_payment_preimage, *payment_preimage);
1076                 },
1077                 _ => panic!("Unexpected event"),
1078         }
1079
1080         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1081         if recv_count > 0 {
1082                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1083                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1084                 assert!(node_1_closing_signed.is_some());
1085         }
1086
1087         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1088         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1089
1090         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1091         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1092         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1093         if recv_count == 0 {
1094                 // If all closing_signeds weren't delivered we can just resume where we left off...
1095                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1096
1097                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1098                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1099                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1100
1101                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1102                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1103                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1104
1105                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_3rd_shutdown);
1106                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1107
1108                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_1_3rd_shutdown);
1109                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1110                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1111
1112                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1113                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1114                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1115                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1116                 assert!(node_0_none.is_none());
1117         } else {
1118                 // If one node, however, received + responded with an identical closing_signed we end
1119                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1120                 // There isn't really anything better we can do simply, but in the future we might
1121                 // explore storing a set of recently-closed channels that got disconnected during
1122                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1123                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1124                 // transaction.
1125                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1126
1127                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1128                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1129                 assert_eq!(msg_events.len(), 1);
1130                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1131                         match action {
1132                                 &ErrorAction::SendErrorMessage { ref msg } => {
1133                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1134                                         assert_eq!(msg.channel_id, chan_1.2);
1135                                 },
1136                                 _ => panic!("Unexpected event!"),
1137                         }
1138                 } else { panic!("Needed SendErrorMessage close"); }
1139
1140                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1141                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1142                 // closing_signed so we do it ourselves
1143                 check_closed_broadcast!(nodes[0], false);
1144                 check_added_monitors!(nodes[0], 1);
1145         }
1146
1147         assert!(nodes[0].node.list_channels().is_empty());
1148
1149         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1150         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1151         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1152         assert!(nodes[1].node.list_channels().is_empty());
1153         assert!(nodes[2].node.list_channels().is_empty());
1154 }
1155
1156 #[test]
1157 fn test_shutdown_rebroadcast() {
1158         do_test_shutdown_rebroadcast(0);
1159         do_test_shutdown_rebroadcast(1);
1160         do_test_shutdown_rebroadcast(2);
1161 }
1162
1163 #[test]
1164 fn fake_network_test() {
1165         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1166         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1167         let chanmon_cfgs = create_chanmon_cfgs(4);
1168         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1169         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1170         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1171
1172         // Create some initial channels
1173         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1174         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1175         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1176
1177         // Rebalance the network a bit by relaying one payment through all the channels...
1178         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1179         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1180         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1181         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
1182
1183         // Send some more payments
1184         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
1185         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
1186         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
1187
1188         // Test failure packets
1189         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1190         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1191
1192         // Add a new channel that skips 3
1193         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1194
1195         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
1196         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
1197         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1198         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1199         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1200         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1201         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
1202
1203         // Do some rebalance loop payments, simultaneously
1204         let mut hops = Vec::with_capacity(3);
1205         hops.push(RouteHop {
1206                 pubkey: nodes[2].node.get_our_node_id(),
1207                 node_features: NodeFeatures::empty(),
1208                 short_channel_id: chan_2.0.contents.short_channel_id,
1209                 channel_features: ChannelFeatures::empty(),
1210                 fee_msat: 0,
1211                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1212         });
1213         hops.push(RouteHop {
1214                 pubkey: nodes[3].node.get_our_node_id(),
1215                 node_features: NodeFeatures::empty(),
1216                 short_channel_id: chan_3.0.contents.short_channel_id,
1217                 channel_features: ChannelFeatures::empty(),
1218                 fee_msat: 0,
1219                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1220         });
1221         hops.push(RouteHop {
1222                 pubkey: nodes[1].node.get_our_node_id(),
1223                 node_features: NodeFeatures::known(),
1224                 short_channel_id: chan_4.0.contents.short_channel_id,
1225                 channel_features: ChannelFeatures::known(),
1226                 fee_msat: 1000000,
1227                 cltv_expiry_delta: TEST_FINAL_CLTV,
1228         });
1229         hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1230         hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1231         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1232
1233         let mut hops = Vec::with_capacity(3);
1234         hops.push(RouteHop {
1235                 pubkey: nodes[3].node.get_our_node_id(),
1236                 node_features: NodeFeatures::empty(),
1237                 short_channel_id: chan_4.0.contents.short_channel_id,
1238                 channel_features: ChannelFeatures::empty(),
1239                 fee_msat: 0,
1240                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1241         });
1242         hops.push(RouteHop {
1243                 pubkey: nodes[2].node.get_our_node_id(),
1244                 node_features: NodeFeatures::empty(),
1245                 short_channel_id: chan_3.0.contents.short_channel_id,
1246                 channel_features: ChannelFeatures::empty(),
1247                 fee_msat: 0,
1248                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1249         });
1250         hops.push(RouteHop {
1251                 pubkey: nodes[1].node.get_our_node_id(),
1252                 node_features: NodeFeatures::known(),
1253                 short_channel_id: chan_2.0.contents.short_channel_id,
1254                 channel_features: ChannelFeatures::known(),
1255                 fee_msat: 1000000,
1256                 cltv_expiry_delta: TEST_FINAL_CLTV,
1257         });
1258         hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1259         hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1260         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1261
1262         // Claim the rebalances...
1263         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1264         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
1265
1266         // Add a duplicate new channel from 2 to 4
1267         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1268
1269         // Send some payments across both channels
1270         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1271         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1272         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1273
1274
1275         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1276         let events = nodes[0].node.get_and_clear_pending_msg_events();
1277         assert_eq!(events.len(), 0);
1278         nodes[0].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap(), 1);
1279
1280         //TODO: Test that routes work again here as we've been notified that the channel is full
1281
1282         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
1283         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
1284         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
1285
1286         // Close down the channels...
1287         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1288         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1289         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1290         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1291         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1292 }
1293
1294 #[test]
1295 fn holding_cell_htlc_counting() {
1296         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1297         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1298         // commitment dance rounds.
1299         let chanmon_cfgs = create_chanmon_cfgs(3);
1300         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1301         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1302         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1303         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1304         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1305         let logger = test_utils::TestLogger::new();
1306
1307         let mut payments = Vec::new();
1308         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1309                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
1310                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1311                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1312                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
1313                 payments.push((payment_preimage, payment_hash));
1314         }
1315         check_added_monitors!(nodes[1], 1);
1316
1317         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1318         assert_eq!(events.len(), 1);
1319         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1320         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1321
1322         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1323         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1324         // another HTLC.
1325         let (_, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[2]);
1326         {
1327                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1328                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1329                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)), true, APIError::ChannelUnavailable { ref err },
1330                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1331                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1332                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1333         }
1334
1335         // This should also be true if we try to forward a payment.
1336         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[2]);
1337         {
1338                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1339                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1340                 nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
1341                 check_added_monitors!(nodes[0], 1);
1342         }
1343
1344         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1345         assert_eq!(events.len(), 1);
1346         let payment_event = SendEvent::from_event(events.pop().unwrap());
1347         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1348
1349         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1350         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1351         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1352         // fails), the second will process the resulting failure and fail the HTLC backward.
1353         expect_pending_htlcs_forwardable!(nodes[1]);
1354         expect_pending_htlcs_forwardable!(nodes[1]);
1355         check_added_monitors!(nodes[1], 1);
1356
1357         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1358         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1359         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1360
1361         let events = nodes[0].node.get_and_clear_pending_msg_events();
1362         assert_eq!(events.len(), 1);
1363         match events[0] {
1364                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1365                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1366                 },
1367                 _ => panic!("Unexpected event"),
1368         }
1369
1370         expect_payment_failed!(nodes[0], payment_hash_2, false);
1371
1372         // Now forward all the pending HTLCs and claim them back
1373         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1374         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1375         check_added_monitors!(nodes[2], 1);
1376
1377         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1378         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1379         check_added_monitors!(nodes[1], 1);
1380         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1381
1382         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1383         check_added_monitors!(nodes[1], 1);
1384         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1385
1386         for ref update in as_updates.update_add_htlcs.iter() {
1387                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1388         }
1389         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1390         check_added_monitors!(nodes[2], 1);
1391         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1392         check_added_monitors!(nodes[2], 1);
1393         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1394
1395         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1396         check_added_monitors!(nodes[1], 1);
1397         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1398         check_added_monitors!(nodes[1], 1);
1399         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1400
1401         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1402         check_added_monitors!(nodes[2], 1);
1403
1404         expect_pending_htlcs_forwardable!(nodes[2]);
1405
1406         let events = nodes[2].node.get_and_clear_pending_events();
1407         assert_eq!(events.len(), payments.len());
1408         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1409                 match event {
1410                         &Event::PaymentReceived { ref payment_hash, .. } => {
1411                                 assert_eq!(*payment_hash, *hash);
1412                         },
1413                         _ => panic!("Unexpected event"),
1414                 };
1415         }
1416
1417         for (preimage, _) in payments.drain(..) {
1418                 claim_payment(&nodes[1], &[&nodes[2]], preimage);
1419         }
1420
1421         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
1422 }
1423
1424 #[test]
1425 fn duplicate_htlc_test() {
1426         // Test that we accept duplicate payment_hash HTLCs across the network and that
1427         // claiming/failing them are all separate and don't affect each other
1428         let chanmon_cfgs = create_chanmon_cfgs(6);
1429         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1430         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1431         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1432
1433         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1434         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1435         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1436         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1437         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1438         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1439
1440         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1441
1442         *nodes[0].network_payment_count.borrow_mut() -= 1;
1443         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1444
1445         *nodes[0].network_payment_count.borrow_mut() -= 1;
1446         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1447
1448         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
1449         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1450         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
1451 }
1452
1453 #[test]
1454 fn test_duplicate_htlc_different_direction_onchain() {
1455         // Test that ChannelMonitor doesn't generate 2 preimage txn
1456         // when we have 2 HTLCs with same preimage that go across a node
1457         // in opposite directions, even with the same payment secret.
1458         let chanmon_cfgs = create_chanmon_cfgs(2);
1459         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1460         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1461         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1462
1463         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1464         let logger = test_utils::TestLogger::new();
1465
1466         // balancing
1467         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
1468
1469         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1470
1471         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1472         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1473         let node_a_payment_secret = nodes[0].node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
1474         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[0]]], 800_000, payment_hash, node_a_payment_secret);
1475
1476         // Provide preimage to node 0 by claiming payment
1477         nodes[0].node.claim_funds(payment_preimage);
1478         check_added_monitors!(nodes[0], 1);
1479
1480         // Broadcast node 1 commitment txn
1481         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1482
1483         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1484         let mut has_both_htlcs = 0; // check htlcs match ones committed
1485         for outp in remote_txn[0].output.iter() {
1486                 if outp.value == 800_000 / 1000 {
1487                         has_both_htlcs += 1;
1488                 } else if outp.value == 900_000 / 1000 {
1489                         has_both_htlcs += 1;
1490                 }
1491         }
1492         assert_eq!(has_both_htlcs, 2);
1493
1494         mine_transaction(&nodes[0], &remote_txn[0]);
1495         check_added_monitors!(nodes[0], 1);
1496
1497         // Check we only broadcast 1 timeout tx
1498         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1499         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()) };
1500         assert_eq!(claim_txn.len(), 5);
1501         check_spends!(claim_txn[2], chan_1.3);
1502         check_spends!(claim_txn[3], claim_txn[2]);
1503         assert_eq!(htlc_pair.0.input.len(), 1);
1504         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1505         check_spends!(htlc_pair.0, remote_txn[0]);
1506         assert_eq!(htlc_pair.1.input.len(), 1);
1507         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1508         check_spends!(htlc_pair.1, remote_txn[0]);
1509
1510         let events = nodes[0].node.get_and_clear_pending_msg_events();
1511         assert_eq!(events.len(), 3);
1512         for e in events {
1513                 match e {
1514                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1515                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1516                                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
1517                                 assert_eq!(msg.data, "Commitment or closing transaction was confirmed on chain.");
1518                         },
1519                         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, .. } } => {
1520                                 assert!(update_add_htlcs.is_empty());
1521                                 assert!(update_fail_htlcs.is_empty());
1522                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1523                                 assert!(update_fail_malformed_htlcs.is_empty());
1524                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1525                         },
1526                         _ => panic!("Unexpected event"),
1527                 }
1528         }
1529 }
1530
1531 #[test]
1532 fn test_basic_channel_reserve() {
1533         let chanmon_cfgs = create_chanmon_cfgs(2);
1534         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1535         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1536         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1537         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1538         let logger = test_utils::TestLogger::new();
1539
1540         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1541         let channel_reserve = chan_stat.channel_reserve_msat;
1542
1543         // The 2* and +1 are for the fee spike reserve.
1544         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
1545         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1546         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1547         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1548         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1549         let err = nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).err().unwrap();
1550         match err {
1551                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1552                         match &fails[0] {
1553                                 &APIError::ChannelUnavailable{ref err} =>
1554                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1555                                 _ => panic!("Unexpected error variant"),
1556                         }
1557                 },
1558                 _ => panic!("Unexpected error variant"),
1559         }
1560         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1561         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1562
1563         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send);
1564 }
1565
1566 #[test]
1567 fn test_fee_spike_violation_fails_htlc() {
1568         let chanmon_cfgs = create_chanmon_cfgs(2);
1569         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1570         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1571         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1572         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1573
1574         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 3460001);
1575         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1576         let secp_ctx = Secp256k1::new();
1577         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1578
1579         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1580
1581         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1582         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &Some(payment_secret), cur_height).unwrap();
1583         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1584         let msg = msgs::UpdateAddHTLC {
1585                 channel_id: chan.2,
1586                 htlc_id: 0,
1587                 amount_msat: htlc_msat,
1588                 payment_hash: payment_hash,
1589                 cltv_expiry: htlc_cltv,
1590                 onion_routing_packet: onion_packet,
1591         };
1592
1593         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1594
1595         // Now manually create the commitment_signed message corresponding to the update_add
1596         // nodes[0] just sent. In the code for construction of this message, "local" refers
1597         // to the sender of the message, and "remote" refers to the receiver.
1598
1599         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1600
1601         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1602
1603         // Get the EnforcingSigner for each channel, which will be used to (1) get the keys
1604         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1605         let (local_revocation_basepoint, local_htlc_basepoint, local_secret, next_local_point) = {
1606                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1607                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1608                 let chan_signer = local_chan.get_signer();
1609                 let pubkeys = chan_signer.pubkeys();
1610                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint,
1611                  chan_signer.release_commitment_secret(INITIAL_COMMITMENT_NUMBER),
1612                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 2, &secp_ctx))
1613         };
1614         let (remote_delayed_payment_basepoint, remote_htlc_basepoint,remote_point) = {
1615                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1616                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1617                 let chan_signer = remote_chan.get_signer();
1618                 let pubkeys = chan_signer.pubkeys();
1619                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint,
1620                  chan_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &secp_ctx))
1621         };
1622
1623         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1624         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &remote_point, &remote_delayed_payment_basepoint,
1625                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1626
1627         // Build the remote commitment transaction so we can sign it, and then later use the
1628         // signature for the commitment_signed message.
1629         let local_chan_balance = 1313;
1630
1631         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1632                 offered: false,
1633                 amount_msat: 3460001,
1634                 cltv_expiry: htlc_cltv,
1635                 payment_hash,
1636                 transaction_output_index: Some(1),
1637         };
1638
1639         let commitment_number = INITIAL_COMMITMENT_NUMBER - 1;
1640
1641         let res = {
1642                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1643                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1644                 let local_chan_signer = local_chan.get_signer();
1645                 let commitment_tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1646                         commitment_number,
1647                         95000,
1648                         local_chan_balance,
1649                         commit_tx_keys.clone(),
1650                         feerate_per_kw,
1651                         &mut vec![(accepted_htlc_info, ())],
1652                         &local_chan.channel_transaction_parameters.as_counterparty_broadcastable()
1653                 );
1654                 local_chan_signer.sign_counterparty_commitment(&commitment_tx, &secp_ctx).unwrap()
1655         };
1656
1657         let commit_signed_msg = msgs::CommitmentSigned {
1658                 channel_id: chan.2,
1659                 signature: res.0,
1660                 htlc_signatures: res.1
1661         };
1662
1663         // Send the commitment_signed message to the nodes[1].
1664         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1665         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1666
1667         // Send the RAA to nodes[1].
1668         let raa_msg = msgs::RevokeAndACK {
1669                 channel_id: chan.2,
1670                 per_commitment_secret: local_secret,
1671                 next_per_commitment_point: next_local_point
1672         };
1673         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1674
1675         let events = nodes[1].node.get_and_clear_pending_msg_events();
1676         assert_eq!(events.len(), 1);
1677         // Make sure the HTLC failed in the way we expect.
1678         match events[0] {
1679                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1680                         assert_eq!(update_fail_htlcs.len(), 1);
1681                         update_fail_htlcs[0].clone()
1682                 },
1683                 _ => panic!("Unexpected event"),
1684         };
1685         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1686
1687         check_added_monitors!(nodes[1], 2);
1688 }
1689
1690 #[test]
1691 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1692         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1693         // Set the fee rate for the channel very high, to the point where the fundee
1694         // sending any above-dust amount would result in a channel reserve violation.
1695         // In this test we check that we would be prevented from sending an HTLC in
1696         // this situation.
1697         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1698         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1699         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1700         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1701         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1702         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1703
1704         let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 4843000);
1705         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1706                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1707         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1708         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_string(), 1);
1709 }
1710
1711 #[test]
1712 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1713         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1714         // Set the fee rate for the channel very high, to the point where the funder
1715         // receiving 1 update_add_htlc would result in them closing the channel due
1716         // to channel reserve violation. This close could also happen if the fee went
1717         // up a more realistic amount, but many HTLCs were outstanding at the time of
1718         // the update_add_htlc.
1719         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1720         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1721         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1722         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1723         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1724         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1725
1726         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[1], nodes[0], 1000);
1727         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1728         let secp_ctx = Secp256k1::new();
1729         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1730         let cur_height = nodes[1].node.best_block.read().unwrap().height() + 1;
1731         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1732         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &Some(payment_secret), cur_height).unwrap();
1733         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1734         let msg = msgs::UpdateAddHTLC {
1735                 channel_id: chan.2,
1736                 htlc_id: 1,
1737                 amount_msat: htlc_msat + 1,
1738                 payment_hash: payment_hash,
1739                 cltv_expiry: htlc_cltv,
1740                 onion_routing_packet: onion_packet,
1741         };
1742
1743         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1744         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1745         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1746         assert_eq!(nodes[0].node.list_channels().len(), 0);
1747         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1748         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1749         check_added_monitors!(nodes[0], 1);
1750 }
1751
1752 #[test]
1753 fn test_chan_reserve_dust_inbound_htlcs_outbound_chan() {
1754         // Test that if we receive many dust HTLCs over an outbound channel, they don't count when
1755         // calculating our commitment transaction fee (this was previously broken).
1756         let chanmon_cfgs = create_chanmon_cfgs(2);
1757         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1758         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1759         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1760
1761         // Set nodes[0]'s balance such that they will consider any above-dust received HTLC to be a
1762         // channel reserve violation (so their balance is channel reserve (1000 sats) + commitment
1763         // transaction fee with 0 HTLCs (183 sats)).
1764         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98817000, InitFeatures::known(), InitFeatures::known());
1765
1766         let dust_amt = 546000; // Dust amount
1767         // In the previous code, routing this dust payment would cause nodes[0] to perceive a channel
1768         // reserve violation even though it's a dust HTLC and therefore shouldn't count towards the
1769         // commitment transaction fee.
1770         let (_, _, _) = route_payment(&nodes[1], &[&nodes[0]], dust_amt);
1771 }
1772
1773 #[test]
1774 fn test_chan_reserve_dust_inbound_htlcs_inbound_chan() {
1775         // Test that if we receive many dust HTLCs over an inbound channel, they don't count when
1776         // calculating our counterparty's commitment transaction fee (this was previously broken).
1777         let chanmon_cfgs = create_chanmon_cfgs(2);
1778         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1779         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1780         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1781         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 98000000, InitFeatures::known(), InitFeatures::known());
1782
1783         let payment_amt = 46000; // Dust amount
1784         // In the previous code, these first four payments would succeed.
1785         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1786         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1787         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1788         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1789
1790         // Then these next 5 would be interpreted by nodes[1] as violating the fee spike buffer.
1791         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1792         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1793         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1794         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1795         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1796
1797         // And this last payment previously resulted in nodes[1] closing on its inbound-channel
1798         // counterparty, because it counted all the previous dust HTLCs against nodes[0]'s commitment
1799         // transaction fee and therefore perceived this next payment as a channel reserve violation.
1800         let (_, _, _) = route_payment(&nodes[0], &[&nodes[1]], payment_amt);
1801 }
1802
1803 #[test]
1804 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1805         let chanmon_cfgs = create_chanmon_cfgs(3);
1806         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1807         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1808         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1809         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1810         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1811
1812         let feemsat = 239;
1813         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1814         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1815         let feerate = get_feerate!(nodes[0], chan.2);
1816
1817         // Add a 2* and +1 for the fee spike reserve.
1818         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1819         let recv_value_1 = (chan_stat.value_to_self_msat - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlc)/2;
1820         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1821
1822         // Add a pending HTLC.
1823         let (route_1, our_payment_hash_1, _, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_1);
1824         let payment_event_1 = {
1825                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1826                 check_added_monitors!(nodes[0], 1);
1827
1828                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1829                 assert_eq!(events.len(), 1);
1830                 SendEvent::from_event(events.remove(0))
1831         };
1832         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1833
1834         // Attempt to trigger a channel reserve violation --> payment failure.
1835         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1836         let recv_value_2 = chan_stat.value_to_self_msat - amt_msat_1 - chan_stat.channel_reserve_msat - total_routing_fee_msat - commit_tx_fee_2_htlcs + 1;
1837         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1838         let (route_2, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat_2);
1839
1840         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1841         let secp_ctx = Secp256k1::new();
1842         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1843         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
1844         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1845         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1846         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1847         let msg = msgs::UpdateAddHTLC {
1848                 channel_id: chan.2,
1849                 htlc_id: 1,
1850                 amount_msat: htlc_msat + 1,
1851                 payment_hash: our_payment_hash_1,
1852                 cltv_expiry: htlc_cltv,
1853                 onion_routing_packet: onion_packet,
1854         };
1855
1856         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1857         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1858         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1859         assert_eq!(nodes[1].node.list_channels().len(), 1);
1860         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1861         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1862         check_added_monitors!(nodes[1], 1);
1863 }
1864
1865 #[test]
1866 fn test_inbound_outbound_capacity_is_not_zero() {
1867         let chanmon_cfgs = create_chanmon_cfgs(2);
1868         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1869         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1870         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1871         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1872         let channels0 = node_chanmgrs[0].list_channels();
1873         let channels1 = node_chanmgrs[1].list_channels();
1874         assert_eq!(channels0.len(), 1);
1875         assert_eq!(channels1.len(), 1);
1876
1877         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1878         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1879
1880         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1881         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1882 }
1883
1884 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1885         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1886 }
1887
1888 #[test]
1889 fn test_channel_reserve_holding_cell_htlcs() {
1890         let chanmon_cfgs = create_chanmon_cfgs(3);
1891         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1892         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1893         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1894         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1895         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1896
1897         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1898         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1899
1900         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1901         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1902
1903         macro_rules! expect_forward {
1904                 ($node: expr) => {{
1905                         let mut events = $node.node.get_and_clear_pending_msg_events();
1906                         assert_eq!(events.len(), 1);
1907                         check_added_monitors!($node, 1);
1908                         let payment_event = SendEvent::from_event(events.remove(0));
1909                         payment_event
1910                 }}
1911         }
1912
1913         let feemsat = 239; // somehow we know?
1914         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1915         let feerate = get_feerate!(nodes[0], chan_1.2);
1916
1917         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1918
1919         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1920         {
1921                 let (mut route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_0);
1922                 route.paths[0].last_mut().unwrap().fee_msat += 1;
1923                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1924                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1925                         assert!(regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap().is_match(err)));
1926                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1927                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
1928         }
1929
1930         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1931         // nodes[0]'s wealth
1932         loop {
1933                 let amt_msat = recv_value_0 + total_fee_msat;
1934                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1935                 // Also, ensure that each payment has enough to be over the dust limit to
1936                 // ensure it'll be included in each commit tx fee calculation.
1937                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1938                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1939                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1940                         break;
1941                 }
1942                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
1943
1944                 let (stat01_, stat11_, stat12_, stat22_) = (
1945                         get_channel_value_stat!(nodes[0], chan_1.2),
1946                         get_channel_value_stat!(nodes[1], chan_1.2),
1947                         get_channel_value_stat!(nodes[1], chan_2.2),
1948                         get_channel_value_stat!(nodes[2], chan_2.2),
1949                 );
1950
1951                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1952                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1953                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1954                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1955                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1956         }
1957
1958         // adding pending output.
1959         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1960         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1961         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1962         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1963         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1964         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1965         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1966         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1967         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1968         // policy.
1969         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1970         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1971         let amt_msat_1 = recv_value_1 + total_fee_msat;
1972
1973         let (route_1, our_payment_hash_1, our_payment_preimage_1, our_payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_1);
1974         let payment_event_1 = {
1975                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &Some(our_payment_secret_1)).unwrap();
1976                 check_added_monitors!(nodes[0], 1);
1977
1978                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1979                 assert_eq!(events.len(), 1);
1980                 SendEvent::from_event(events.remove(0))
1981         };
1982         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1983
1984         // channel reserve test with htlc pending output > 0
1985         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1986         {
1987                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_2 + 1);
1988                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
1989                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
1990                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1991         }
1992
1993         // split the rest to test holding cell
1994         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1995         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
1996         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
1997         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
1998         {
1999                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2000                 assert_eq!(stat.value_to_self_msat - (stat.pending_outbound_htlcs_amount_msat + recv_value_21 + recv_value_22 + total_fee_msat + total_fee_msat + commit_tx_fee_3_htlcs), stat.channel_reserve_msat);
2001         }
2002
2003         // now see if they go through on both sides
2004         let (route_21, our_payment_hash_21, our_payment_preimage_21, our_payment_secret_21) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_21);
2005         // but this will stuck in the holding cell
2006         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &Some(our_payment_secret_21)).unwrap();
2007         check_added_monitors!(nodes[0], 0);
2008         let events = nodes[0].node.get_and_clear_pending_events();
2009         assert_eq!(events.len(), 0);
2010
2011         // test with outbound holding cell amount > 0
2012         {
2013                 let (route, our_payment_hash, _, our_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22+1);
2014                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
2015                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2016                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2017                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 2);
2018         }
2019
2020         let (route_22, our_payment_hash_22, our_payment_preimage_22, our_payment_secret_22) = get_route_and_payment_hash!(nodes[0], nodes[2], recv_value_22);
2021         // this will also stuck in the holding cell
2022         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &Some(our_payment_secret_22)).unwrap();
2023         check_added_monitors!(nodes[0], 0);
2024         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2025         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2026
2027         // flush the pending htlc
2028         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2029         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2030         check_added_monitors!(nodes[1], 1);
2031
2032         // the pending htlc should be promoted to committed
2033         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2034         check_added_monitors!(nodes[0], 1);
2035         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2036
2037         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2038         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2039         // No commitment_signed so get_event_msg's assert(len == 1) passes
2040         check_added_monitors!(nodes[0], 1);
2041
2042         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2043         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2044         check_added_monitors!(nodes[1], 1);
2045
2046         expect_pending_htlcs_forwardable!(nodes[1]);
2047
2048         let ref payment_event_11 = expect_forward!(nodes[1]);
2049         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2050         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2051
2052         expect_pending_htlcs_forwardable!(nodes[2]);
2053         expect_payment_received!(nodes[2], our_payment_hash_1, our_payment_secret_1, recv_value_1);
2054
2055         // flush the htlcs in the holding cell
2056         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2057         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2058         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2059         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2060         expect_pending_htlcs_forwardable!(nodes[1]);
2061
2062         let ref payment_event_3 = expect_forward!(nodes[1]);
2063         assert_eq!(payment_event_3.msgs.len(), 2);
2064         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2065         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2066
2067         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2068         expect_pending_htlcs_forwardable!(nodes[2]);
2069
2070         let events = nodes[2].node.get_and_clear_pending_events();
2071         assert_eq!(events.len(), 2);
2072         match events[0] {
2073                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2074                         assert_eq!(our_payment_hash_21, *payment_hash);
2075                         assert!(payment_preimage.is_none());
2076                         assert_eq!(our_payment_secret_21, *payment_secret);
2077                         assert_eq!(recv_value_21, amt);
2078                 },
2079                 _ => panic!("Unexpected event"),
2080         }
2081         match events[1] {
2082                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
2083                         assert_eq!(our_payment_hash_22, *payment_hash);
2084                         assert!(payment_preimage.is_none());
2085                         assert_eq!(our_payment_secret_22, *payment_secret);
2086                         assert_eq!(recv_value_22, amt);
2087                 },
2088                 _ => panic!("Unexpected event"),
2089         }
2090
2091         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
2092         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
2093         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
2094
2095         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2096         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2097         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3);
2098
2099         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2100         let expected_value_to_self = stat01.value_to_self_msat - (recv_value_1 + total_fee_msat) - (recv_value_21 + total_fee_msat) - (recv_value_22 + total_fee_msat) - (recv_value_3 + total_fee_msat);
2101         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2102         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2103         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2104
2105         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2106         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2107 }
2108
2109 #[test]
2110 fn channel_reserve_in_flight_removes() {
2111         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2112         // can send to its counterparty, but due to update ordering, the other side may not yet have
2113         // considered those HTLCs fully removed.
2114         // This tests that we don't count HTLCs which will not be included in the next remote
2115         // commitment transaction towards the reserve value (as it implies no commitment transaction
2116         // will be generated which violates the remote reserve value).
2117         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2118         // To test this we:
2119         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2120         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2121         //    you only consider the value of the first HTLC, it may not),
2122         //  * start routing a third HTLC from A to B,
2123         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2124         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2125         //  * deliver the first fulfill from B
2126         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2127         //    claim,
2128         //  * deliver A's response CS and RAA.
2129         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2130         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2131         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2132         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2133         let chanmon_cfgs = create_chanmon_cfgs(2);
2134         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2135         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2136         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2137         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2138         let logger = test_utils::TestLogger::new();
2139
2140         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2141         // Route the first two HTLCs.
2142         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2143         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2144
2145         // Start routing the third HTLC (this is just used to get everyone in the right state).
2146         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2147         let send_1 = {
2148                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2149                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2150                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2151                 check_added_monitors!(nodes[0], 1);
2152                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2153                 assert_eq!(events.len(), 1);
2154                 SendEvent::from_event(events.remove(0))
2155         };
2156
2157         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2158         // initial fulfill/CS.
2159         assert!(nodes[1].node.claim_funds(payment_preimage_1));
2160         check_added_monitors!(nodes[1], 1);
2161         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2162
2163         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2164         // remove the second HTLC when we send the HTLC back from B to A.
2165         assert!(nodes[1].node.claim_funds(payment_preimage_2));
2166         check_added_monitors!(nodes[1], 1);
2167         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2168
2169         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2170         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2171         check_added_monitors!(nodes[0], 1);
2172         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2173         expect_payment_sent!(nodes[0], payment_preimage_1);
2174
2175         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2176         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2177         check_added_monitors!(nodes[1], 1);
2178         // B is already AwaitingRAA, so cant generate a CS here
2179         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2180
2181         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2182         check_added_monitors!(nodes[1], 1);
2183         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2184
2185         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2186         check_added_monitors!(nodes[0], 1);
2187         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2188
2189         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2190         check_added_monitors!(nodes[1], 1);
2191         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2192
2193         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2194         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2195         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2196         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2197         // on-chain as necessary).
2198         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2199         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2200         check_added_monitors!(nodes[0], 1);
2201         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2202         expect_payment_sent!(nodes[0], payment_preimage_2);
2203
2204         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2205         check_added_monitors!(nodes[1], 1);
2206         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2207
2208         expect_pending_htlcs_forwardable!(nodes[1]);
2209         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2210
2211         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2212         // resolve the second HTLC from A's point of view.
2213         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2214         check_added_monitors!(nodes[0], 1);
2215         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2216
2217         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2218         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2219         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2220         let send_2 = {
2221                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2222                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2223                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2224                 check_added_monitors!(nodes[1], 1);
2225                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2226                 assert_eq!(events.len(), 1);
2227                 SendEvent::from_event(events.remove(0))
2228         };
2229
2230         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2231         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2232         check_added_monitors!(nodes[0], 1);
2233         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2234
2235         // Now just resolve all the outstanding messages/HTLCs for completeness...
2236
2237         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2238         check_added_monitors!(nodes[1], 1);
2239         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2240
2241         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2242         check_added_monitors!(nodes[1], 1);
2243
2244         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2245         check_added_monitors!(nodes[0], 1);
2246         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2247
2248         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2249         check_added_monitors!(nodes[1], 1);
2250         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2251
2252         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2253         check_added_monitors!(nodes[0], 1);
2254
2255         expect_pending_htlcs_forwardable!(nodes[0]);
2256         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2257
2258         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4);
2259         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3);
2260 }
2261
2262 #[test]
2263 fn channel_monitor_network_test() {
2264         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2265         // tests that ChannelMonitor is able to recover from various states.
2266         let chanmon_cfgs = create_chanmon_cfgs(5);
2267         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2268         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2269         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2270
2271         // Create some initial channels
2272         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2273         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2274         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2275         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2276
2277         // Make sure all nodes are at the same starting height
2278         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2279         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2280         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2281         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2282         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2283
2284         // Rebalance the network a bit by relaying one payment through all the channels...
2285         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2286         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2287         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2288         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2289
2290         // Simple case with no pending HTLCs:
2291         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2292         check_added_monitors!(nodes[1], 1);
2293         check_closed_broadcast!(nodes[1], false);
2294         {
2295                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2296                 assert_eq!(node_txn.len(), 1);
2297                 mine_transaction(&nodes[0], &node_txn[0]);
2298                 check_added_monitors!(nodes[0], 1);
2299                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2300         }
2301         check_closed_broadcast!(nodes[0], true);
2302         assert_eq!(nodes[0].node.list_channels().len(), 0);
2303         assert_eq!(nodes[1].node.list_channels().len(), 1);
2304
2305         // One pending HTLC is discarded by the force-close:
2306         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2307
2308         // Simple case of one pending HTLC to HTLC-Timeout
2309         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2310         check_closed_broadcast!(nodes[1], false);
2311         check_added_monitors!(nodes[1], 1);
2312         {
2313                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2314                 mine_transaction(&nodes[2], &node_txn[0]);
2315                 check_added_monitors!(nodes[2], 1);
2316                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2317         }
2318         check_closed_broadcast!(nodes[2], true);
2319         assert_eq!(nodes[1].node.list_channels().len(), 0);
2320         assert_eq!(nodes[2].node.list_channels().len(), 1);
2321
2322         macro_rules! claim_funds {
2323                 ($node: expr, $prev_node: expr, $preimage: expr) => {
2324                         {
2325                                 assert!($node.node.claim_funds($preimage));
2326                                 check_added_monitors!($node, 1);
2327
2328                                 let events = $node.node.get_and_clear_pending_msg_events();
2329                                 assert_eq!(events.len(), 1);
2330                                 match events[0] {
2331                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2332                                                 assert!(update_add_htlcs.is_empty());
2333                                                 assert!(update_fail_htlcs.is_empty());
2334                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2335                                         },
2336                                         _ => panic!("Unexpected event"),
2337                                 };
2338                         }
2339                 }
2340         }
2341
2342         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2343         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2344         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2345         check_added_monitors!(nodes[2], 1);
2346         check_closed_broadcast!(nodes[2], false);
2347         let node2_commitment_txid;
2348         {
2349                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2350                 node2_commitment_txid = node_txn[0].txid();
2351
2352                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2353                 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
2354                 mine_transaction(&nodes[3], &node_txn[0]);
2355                 check_added_monitors!(nodes[3], 1);
2356                 check_preimage_claim(&nodes[3], &node_txn);
2357         }
2358         check_closed_broadcast!(nodes[3], true);
2359         assert_eq!(nodes[2].node.list_channels().len(), 0);
2360         assert_eq!(nodes[3].node.list_channels().len(), 1);
2361
2362         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2363         // confusing us in the following tests.
2364         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2365
2366         // One pending HTLC to time out:
2367         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2368         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2369         // buffer space).
2370
2371         let (close_chan_update_1, close_chan_update_2) = {
2372                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2373                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2374                 assert_eq!(events.len(), 2);
2375                 let close_chan_update_1 = match events[0] {
2376                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2377                                 msg.clone()
2378                         },
2379                         _ => panic!("Unexpected event"),
2380                 };
2381                 match events[1] {
2382                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2383                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2384                         },
2385                         _ => panic!("Unexpected event"),
2386                 }
2387                 check_added_monitors!(nodes[3], 1);
2388
2389                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2390                 {
2391                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2392                         node_txn.retain(|tx| {
2393                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2394                                         false
2395                                 } else { true }
2396                         });
2397                 }
2398
2399                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2400
2401                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2402                 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
2403
2404                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2405                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2406                 assert_eq!(events.len(), 2);
2407                 let close_chan_update_2 = match events[0] {
2408                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2409                                 msg.clone()
2410                         },
2411                         _ => panic!("Unexpected event"),
2412                 };
2413                 match events[1] {
2414                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2415                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2416                         },
2417                         _ => panic!("Unexpected event"),
2418                 }
2419                 check_added_monitors!(nodes[4], 1);
2420                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2421
2422                 mine_transaction(&nodes[4], &node_txn[0]);
2423                 check_preimage_claim(&nodes[4], &node_txn);
2424                 (close_chan_update_1, close_chan_update_2)
2425         };
2426         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2427         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2428         assert_eq!(nodes[3].node.list_channels().len(), 0);
2429         assert_eq!(nodes[4].node.list_channels().len(), 0);
2430
2431         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2432 }
2433
2434 #[test]
2435 fn test_justice_tx() {
2436         // Test justice txn built on revoked HTLC-Success tx, against both sides
2437         let mut alice_config = UserConfig::default();
2438         alice_config.channel_options.announced_channel = true;
2439         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2440         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2441         let mut bob_config = UserConfig::default();
2442         bob_config.channel_options.announced_channel = true;
2443         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2444         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2445         let user_cfgs = [Some(alice_config), Some(bob_config)];
2446         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2447         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2448         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2449         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2450         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2451         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2452         // Create some new channels:
2453         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2454
2455         // A pending HTLC which will be revoked:
2456         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2457         // Get the will-be-revoked local txn from nodes[0]
2458         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2459         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2460         assert_eq!(revoked_local_txn[0].input.len(), 1);
2461         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2462         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2463         assert_eq!(revoked_local_txn[1].input.len(), 1);
2464         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2465         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2466         // Revoke the old state
2467         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
2468
2469         {
2470                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2471                 {
2472                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2473                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2474                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2475
2476                         check_spends!(node_txn[0], revoked_local_txn[0]);
2477                         node_txn.swap_remove(0);
2478                         node_txn.truncate(1);
2479                 }
2480                 check_added_monitors!(nodes[1], 1);
2481                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2482
2483                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2484                 // Verify broadcast of revoked HTLC-timeout
2485                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2486                 check_added_monitors!(nodes[0], 1);
2487                 // Broadcast revoked HTLC-timeout on node 1
2488                 mine_transaction(&nodes[1], &node_txn[1]);
2489                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2490         }
2491         get_announce_close_broadcast_events(&nodes, 0, 1);
2492
2493         assert_eq!(nodes[0].node.list_channels().len(), 0);
2494         assert_eq!(nodes[1].node.list_channels().len(), 0);
2495
2496         // We test justice_tx build by A on B's revoked HTLC-Success tx
2497         // Create some new channels:
2498         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2499         {
2500                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2501                 node_txn.clear();
2502         }
2503
2504         // A pending HTLC which will be revoked:
2505         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2506         // Get the will-be-revoked local txn from B
2507         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2508         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2509         assert_eq!(revoked_local_txn[0].input.len(), 1);
2510         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2511         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2512         // Revoke the old state
2513         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
2514         {
2515                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2516                 {
2517                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2518                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2519                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2520
2521                         check_spends!(node_txn[0], revoked_local_txn[0]);
2522                         node_txn.swap_remove(0);
2523                 }
2524                 check_added_monitors!(nodes[0], 1);
2525                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2526
2527                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2528                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2529                 check_added_monitors!(nodes[1], 1);
2530                 mine_transaction(&nodes[0], &node_txn[1]);
2531                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2532         }
2533         get_announce_close_broadcast_events(&nodes, 0, 1);
2534         assert_eq!(nodes[0].node.list_channels().len(), 0);
2535         assert_eq!(nodes[1].node.list_channels().len(), 0);
2536 }
2537
2538 #[test]
2539 fn revoked_output_claim() {
2540         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2541         // transaction is broadcast by its counterparty
2542         let chanmon_cfgs = create_chanmon_cfgs(2);
2543         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2544         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2545         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2546         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2547         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2548         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2549         assert_eq!(revoked_local_txn.len(), 1);
2550         // Only output is the full channel value back to nodes[0]:
2551         assert_eq!(revoked_local_txn[0].output.len(), 1);
2552         // Send a payment through, updating everyone's latest commitment txn
2553         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
2554
2555         // Inform nodes[1] that nodes[0] broadcast a stale tx
2556         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2557         check_added_monitors!(nodes[1], 1);
2558         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2559         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2560
2561         check_spends!(node_txn[0], revoked_local_txn[0]);
2562         check_spends!(node_txn[1], chan_1.3);
2563
2564         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2565         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2566         get_announce_close_broadcast_events(&nodes, 0, 1);
2567         check_added_monitors!(nodes[0], 1)
2568 }
2569
2570 #[test]
2571 fn claim_htlc_outputs_shared_tx() {
2572         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2573         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2574         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2575         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2576         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2577         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2578
2579         // Create some new channel:
2580         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2581
2582         // Rebalance the network to generate htlc in the two directions
2583         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2584         // 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
2585         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2586         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2587
2588         // Get the will-be-revoked local txn from node[0]
2589         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2590         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2591         assert_eq!(revoked_local_txn[0].input.len(), 1);
2592         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2593         assert_eq!(revoked_local_txn[1].input.len(), 1);
2594         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2595         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2596         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2597
2598         //Revoke the old state
2599         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2600
2601         {
2602                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2603                 check_added_monitors!(nodes[0], 1);
2604                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2605                 check_added_monitors!(nodes[1], 1);
2606                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2607                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2608
2609                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2610                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2611
2612                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2613                 check_spends!(node_txn[0], revoked_local_txn[0]);
2614
2615                 let mut witness_lens = BTreeSet::new();
2616                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2617                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2618                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2619                 assert_eq!(witness_lens.len(), 3);
2620                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2621                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2622                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2623
2624                 // Next nodes[1] broadcasts its current local tx state:
2625                 assert_eq!(node_txn[1].input.len(), 1);
2626                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2627
2628                 assert_eq!(node_txn[2].input.len(), 1);
2629                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2630                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2631                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2632                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2633                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2634         }
2635         get_announce_close_broadcast_events(&nodes, 0, 1);
2636         assert_eq!(nodes[0].node.list_channels().len(), 0);
2637         assert_eq!(nodes[1].node.list_channels().len(), 0);
2638 }
2639
2640 #[test]
2641 fn claim_htlc_outputs_single_tx() {
2642         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2643         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2644         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2645         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2646         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2647         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2648
2649         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2650
2651         // Rebalance the network to generate htlc in the two directions
2652         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
2653         // 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
2654         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2655         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2656         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2657
2658         // Get the will-be-revoked local txn from node[0]
2659         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2660
2661         //Revoke the old state
2662         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
2663
2664         {
2665                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2666                 check_added_monitors!(nodes[0], 1);
2667                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2668                 check_added_monitors!(nodes[1], 1);
2669                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2670
2671                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2672                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2673
2674                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2675                 assert_eq!(node_txn.len(), 9);
2676                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2677                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2678                 // 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)
2679                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2680
2681                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2682                 assert_eq!(node_txn[0].input.len(), 1);
2683                 check_spends!(node_txn[0], chan_1.3);
2684                 assert_eq!(node_txn[1].input.len(), 1);
2685                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2686                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2687                 check_spends!(node_txn[1], node_txn[0]);
2688
2689                 // Justice transactions are indices 1-2-4
2690                 assert_eq!(node_txn[2].input.len(), 1);
2691                 assert_eq!(node_txn[3].input.len(), 1);
2692                 assert_eq!(node_txn[4].input.len(), 1);
2693
2694                 check_spends!(node_txn[2], revoked_local_txn[0]);
2695                 check_spends!(node_txn[3], revoked_local_txn[0]);
2696                 check_spends!(node_txn[4], revoked_local_txn[0]);
2697
2698                 let mut witness_lens = BTreeSet::new();
2699                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2700                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2701                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2702                 assert_eq!(witness_lens.len(), 3);
2703                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2704                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2705                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2706         }
2707         get_announce_close_broadcast_events(&nodes, 0, 1);
2708         assert_eq!(nodes[0].node.list_channels().len(), 0);
2709         assert_eq!(nodes[1].node.list_channels().len(), 0);
2710 }
2711
2712 #[test]
2713 fn test_htlc_on_chain_success() {
2714         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2715         // the preimage backward accordingly. So here we test that ChannelManager is
2716         // broadcasting the right event to other nodes in payment path.
2717         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2718         // A --------------------> B ----------------------> C (preimage)
2719         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2720         // commitment transaction was broadcast.
2721         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2722         // towards B.
2723         // B should be able to claim via preimage if A then broadcasts its local tx.
2724         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2725         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2726         // PaymentSent event).
2727
2728         let chanmon_cfgs = create_chanmon_cfgs(3);
2729         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2730         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2731         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2732
2733         // Create some initial channels
2734         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2735         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2736
2737         // Rebalance the network a bit by relaying one payment through all the channels...
2738         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2739         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2740
2741         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2742         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2743
2744         // Broadcast legit commitment tx from C on B's chain
2745         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2746         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2747         assert_eq!(commitment_tx.len(), 1);
2748         check_spends!(commitment_tx[0], chan_2.3);
2749         nodes[2].node.claim_funds(our_payment_preimage);
2750         nodes[2].node.claim_funds(our_payment_preimage_2);
2751         check_added_monitors!(nodes[2], 2);
2752         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2753         assert!(updates.update_add_htlcs.is_empty());
2754         assert!(updates.update_fail_htlcs.is_empty());
2755         assert!(updates.update_fail_malformed_htlcs.is_empty());
2756         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2757
2758         mine_transaction(&nodes[2], &commitment_tx[0]);
2759         check_closed_broadcast!(nodes[2], true);
2760         check_added_monitors!(nodes[2], 1);
2761         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)
2762         assert_eq!(node_txn.len(), 5);
2763         assert_eq!(node_txn[0], node_txn[3]);
2764         assert_eq!(node_txn[1], node_txn[4]);
2765         assert_eq!(node_txn[2], commitment_tx[0]);
2766         check_spends!(node_txn[0], commitment_tx[0]);
2767         check_spends!(node_txn[1], commitment_tx[0]);
2768         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2769         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2770         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2771         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2772         assert_eq!(node_txn[0].lock_time, 0);
2773         assert_eq!(node_txn[1].lock_time, 0);
2774
2775         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2776         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2777         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2778         {
2779                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2780                 assert_eq!(added_monitors.len(), 1);
2781                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2782                 added_monitors.clear();
2783         }
2784         let events = nodes[1].node.get_and_clear_pending_msg_events();
2785         {
2786                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2787                 assert_eq!(added_monitors.len(), 2);
2788                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2789                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2790                 added_monitors.clear();
2791         }
2792         assert_eq!(events.len(), 3);
2793         match events[0] {
2794                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2795                 _ => panic!("Unexpected event"),
2796         }
2797         match events[1] {
2798                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2799                 _ => panic!("Unexpected event"),
2800         }
2801
2802         match events[2] {
2803                 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, .. } } => {
2804                         assert!(update_add_htlcs.is_empty());
2805                         assert!(update_fail_htlcs.is_empty());
2806                         assert_eq!(update_fulfill_htlcs.len(), 1);
2807                         assert!(update_fail_malformed_htlcs.is_empty());
2808                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2809                 },
2810                 _ => panic!("Unexpected event"),
2811         };
2812         macro_rules! check_tx_local_broadcast {
2813                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2814                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2815                         assert_eq!(node_txn.len(), 5);
2816                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2817                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2818                         check_spends!(node_txn[0], $commitment_tx);
2819                         check_spends!(node_txn[1], $commitment_tx);
2820                         assert_ne!(node_txn[0].lock_time, 0);
2821                         assert_ne!(node_txn[1].lock_time, 0);
2822                         if $htlc_offered {
2823                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2824                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2825                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2826                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2827                         } else {
2828                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2829                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2830                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2831                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2832                         }
2833                         check_spends!(node_txn[2], $chan_tx);
2834                         check_spends!(node_txn[3], node_txn[2]);
2835                         check_spends!(node_txn[4], node_txn[2]);
2836                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2837                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2838                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2839                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2840                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2841                         assert_ne!(node_txn[3].lock_time, 0);
2842                         assert_ne!(node_txn[4].lock_time, 0);
2843                         node_txn.clear();
2844                 } }
2845         }
2846         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2847         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2848         // timeout-claim of the output that nodes[2] just claimed via success.
2849         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2850
2851         // Broadcast legit commitment tx from A on B's chain
2852         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2853         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2854         check_spends!(commitment_tx[0], chan_1.3);
2855         mine_transaction(&nodes[1], &commitment_tx[0]);
2856         check_closed_broadcast!(nodes[1], true);
2857         check_added_monitors!(nodes[1], 1);
2858         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2859         assert_eq!(node_txn.len(), 4);
2860         check_spends!(node_txn[0], commitment_tx[0]);
2861         assert_eq!(node_txn[0].input.len(), 2);
2862         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2863         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2864         assert_eq!(node_txn[0].lock_time, 0);
2865         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2866         check_spends!(node_txn[1], chan_1.3);
2867         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2868         check_spends!(node_txn[2], node_txn[1]);
2869         check_spends!(node_txn[3], node_txn[1]);
2870         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2871         // we already checked the same situation with A.
2872
2873         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2874         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2875         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] });
2876         check_closed_broadcast!(nodes[0], true);
2877         check_added_monitors!(nodes[0], 1);
2878         let events = nodes[0].node.get_and_clear_pending_events();
2879         assert_eq!(events.len(), 2);
2880         let mut first_claimed = false;
2881         for event in events {
2882                 match event {
2883                         Event::PaymentSent { payment_preimage } => {
2884                                 if payment_preimage == our_payment_preimage {
2885                                         assert!(!first_claimed);
2886                                         first_claimed = true;
2887                                 } else {
2888                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2889                                 }
2890                         },
2891                         _ => panic!("Unexpected event"),
2892                 }
2893         }
2894         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2895 }
2896
2897 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2898         // Test that in case of a unilateral close onchain, we detect the state of output and
2899         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2900         // broadcasting the right event to other nodes in payment path.
2901         // A ------------------> B ----------------------> C (timeout)
2902         //    B's commitment tx                 C's commitment tx
2903         //            \                                  \
2904         //         B's HTLC timeout tx               B's timeout tx
2905
2906         let chanmon_cfgs = create_chanmon_cfgs(3);
2907         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2908         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2909         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2910         *nodes[0].connect_style.borrow_mut() = connect_style;
2911         *nodes[1].connect_style.borrow_mut() = connect_style;
2912         *nodes[2].connect_style.borrow_mut() = connect_style;
2913
2914         // Create some intial channels
2915         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2916         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2917
2918         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2919         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2920         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
2921
2922         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2923
2924         // Broadcast legit commitment tx from C on B's chain
2925         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2926         check_spends!(commitment_tx[0], chan_2.3);
2927         nodes[2].node.fail_htlc_backwards(&payment_hash);
2928         check_added_monitors!(nodes[2], 0);
2929         expect_pending_htlcs_forwardable!(nodes[2]);
2930         check_added_monitors!(nodes[2], 1);
2931
2932         let events = nodes[2].node.get_and_clear_pending_msg_events();
2933         assert_eq!(events.len(), 1);
2934         match events[0] {
2935                 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, .. } } => {
2936                         assert!(update_add_htlcs.is_empty());
2937                         assert!(!update_fail_htlcs.is_empty());
2938                         assert!(update_fulfill_htlcs.is_empty());
2939                         assert!(update_fail_malformed_htlcs.is_empty());
2940                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2941                 },
2942                 _ => panic!("Unexpected event"),
2943         };
2944         mine_transaction(&nodes[2], &commitment_tx[0]);
2945         check_closed_broadcast!(nodes[2], true);
2946         check_added_monitors!(nodes[2], 1);
2947         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2948         assert_eq!(node_txn.len(), 1);
2949         check_spends!(node_txn[0], chan_2.3);
2950         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2951
2952         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2953         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2954         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2955         mine_transaction(&nodes[1], &commitment_tx[0]);
2956         let timeout_tx;
2957         {
2958                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2959                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2960                 assert_eq!(node_txn[0], node_txn[3]);
2961                 assert_eq!(node_txn[1], node_txn[4]);
2962
2963                 check_spends!(node_txn[2], commitment_tx[0]);
2964                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2965
2966                 check_spends!(node_txn[0], chan_2.3);
2967                 check_spends!(node_txn[1], node_txn[0]);
2968                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2969                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2970
2971                 timeout_tx = node_txn[2].clone();
2972                 node_txn.clear();
2973         }
2974
2975         mine_transaction(&nodes[1], &timeout_tx);
2976         check_added_monitors!(nodes[1], 1);
2977         check_closed_broadcast!(nodes[1], true);
2978         {
2979                 // B will rebroadcast a fee-bumped timeout transaction here.
2980                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2981                 assert_eq!(node_txn.len(), 1);
2982                 check_spends!(node_txn[0], commitment_tx[0]);
2983         }
2984
2985         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2986         {
2987                 // B will rebroadcast its own holder commitment transaction here...just because
2988                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2989                 assert_eq!(node_txn.len(), 1);
2990                 check_spends!(node_txn[0], chan_2.3);
2991         }
2992
2993         expect_pending_htlcs_forwardable!(nodes[1]);
2994         check_added_monitors!(nodes[1], 1);
2995         let events = nodes[1].node.get_and_clear_pending_msg_events();
2996         assert_eq!(events.len(), 1);
2997         match events[0] {
2998                 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, .. } } => {
2999                         assert!(update_add_htlcs.is_empty());
3000                         assert!(!update_fail_htlcs.is_empty());
3001                         assert!(update_fulfill_htlcs.is_empty());
3002                         assert!(update_fail_malformed_htlcs.is_empty());
3003                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3004                 },
3005                 _ => panic!("Unexpected event"),
3006         };
3007
3008         // Broadcast legit commitment tx from B on A's chain
3009         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3010         check_spends!(commitment_tx[0], chan_1.3);
3011
3012         mine_transaction(&nodes[0], &commitment_tx[0]);
3013
3014         check_closed_broadcast!(nodes[0], true);
3015         check_added_monitors!(nodes[0], 1);
3016         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3017         assert_eq!(node_txn.len(), 3);
3018         check_spends!(node_txn[0], commitment_tx[0]);
3019         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3020         check_spends!(node_txn[1], chan_1.3);
3021         check_spends!(node_txn[2], node_txn[1]);
3022         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3023         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3024 }
3025
3026 #[test]
3027 fn test_htlc_on_chain_timeout() {
3028         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3029         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3030         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3031 }
3032
3033 #[test]
3034 fn test_simple_commitment_revoked_fail_backward() {
3035         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3036         // and fail backward accordingly.
3037
3038         let chanmon_cfgs = create_chanmon_cfgs(3);
3039         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3040         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3041         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3042
3043         // Create some initial channels
3044         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3045         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3046
3047         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3048         // Get the will-be-revoked local txn from nodes[2]
3049         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3050         // Revoke the old state
3051         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3052
3053         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3054
3055         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3056         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3057         check_added_monitors!(nodes[1], 1);
3058         check_closed_broadcast!(nodes[1], true);
3059
3060         expect_pending_htlcs_forwardable!(nodes[1]);
3061         check_added_monitors!(nodes[1], 1);
3062         let events = nodes[1].node.get_and_clear_pending_msg_events();
3063         assert_eq!(events.len(), 1);
3064         match events[0] {
3065                 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, .. } } => {
3066                         assert!(update_add_htlcs.is_empty());
3067                         assert_eq!(update_fail_htlcs.len(), 1);
3068                         assert!(update_fulfill_htlcs.is_empty());
3069                         assert!(update_fail_malformed_htlcs.is_empty());
3070                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3071
3072                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3073                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3074
3075                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3076                         assert_eq!(events.len(), 1);
3077                         match events[0] {
3078                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3079                                 _ => panic!("Unexpected event"),
3080                         }
3081                         expect_payment_failed!(nodes[0], payment_hash, false);
3082                 },
3083                 _ => panic!("Unexpected event"),
3084         }
3085 }
3086
3087 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3088         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3089         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3090         // commitment transaction anymore.
3091         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3092         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3093         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3094         // technically disallowed and we should probably handle it reasonably.
3095         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3096         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3097         // transactions:
3098         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3099         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3100         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3101         //   and once they revoke the previous commitment transaction (allowing us to send a new
3102         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3103         let chanmon_cfgs = create_chanmon_cfgs(3);
3104         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3105         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3106         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3107
3108         // Create some initial channels
3109         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3110         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3111
3112         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3113         // Get the will-be-revoked local txn from nodes[2]
3114         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3115         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3116         // Revoke the old state
3117         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
3118
3119         let value = if use_dust {
3120                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3121                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3122                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3123         } else { 3000000 };
3124
3125         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3126         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3127         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3128
3129         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
3130         expect_pending_htlcs_forwardable!(nodes[2]);
3131         check_added_monitors!(nodes[2], 1);
3132         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3133         assert!(updates.update_add_htlcs.is_empty());
3134         assert!(updates.update_fulfill_htlcs.is_empty());
3135         assert!(updates.update_fail_malformed_htlcs.is_empty());
3136         assert_eq!(updates.update_fail_htlcs.len(), 1);
3137         assert!(updates.update_fee.is_none());
3138         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3139         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3140         // Drop the last RAA from 3 -> 2
3141
3142         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
3143         expect_pending_htlcs_forwardable!(nodes[2]);
3144         check_added_monitors!(nodes[2], 1);
3145         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3146         assert!(updates.update_add_htlcs.is_empty());
3147         assert!(updates.update_fulfill_htlcs.is_empty());
3148         assert!(updates.update_fail_malformed_htlcs.is_empty());
3149         assert_eq!(updates.update_fail_htlcs.len(), 1);
3150         assert!(updates.update_fee.is_none());
3151         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3152         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3153         check_added_monitors!(nodes[1], 1);
3154         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3155         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3156         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3157         check_added_monitors!(nodes[2], 1);
3158
3159         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
3160         expect_pending_htlcs_forwardable!(nodes[2]);
3161         check_added_monitors!(nodes[2], 1);
3162         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3163         assert!(updates.update_add_htlcs.is_empty());
3164         assert!(updates.update_fulfill_htlcs.is_empty());
3165         assert!(updates.update_fail_malformed_htlcs.is_empty());
3166         assert_eq!(updates.update_fail_htlcs.len(), 1);
3167         assert!(updates.update_fee.is_none());
3168         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3169         // At this point first_payment_hash has dropped out of the latest two commitment
3170         // transactions that nodes[1] is tracking...
3171         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3172         check_added_monitors!(nodes[1], 1);
3173         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3174         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3175         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3176         check_added_monitors!(nodes[2], 1);
3177
3178         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3179         // on nodes[2]'s RAA.
3180         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3181         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3182         let logger = test_utils::TestLogger::new();
3183         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3184         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3185         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3186         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3187         check_added_monitors!(nodes[1], 0);
3188
3189         if deliver_bs_raa {
3190                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3191                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3192                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3193                 check_added_monitors!(nodes[1], 1);
3194                 let events = nodes[1].node.get_and_clear_pending_events();
3195                 assert_eq!(events.len(), 1);
3196                 match events[0] {
3197                         Event::PendingHTLCsForwardable { .. } => { },
3198                         _ => panic!("Unexpected event"),
3199                 };
3200                 // Deliberately don't process the pending fail-back so they all fail back at once after
3201                 // block connection just like the !deliver_bs_raa case
3202         }
3203
3204         let mut failed_htlcs = HashSet::new();
3205         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3206
3207         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3208         check_added_monitors!(nodes[1], 1);
3209         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3210
3211         let events = nodes[1].node.get_and_clear_pending_events();
3212         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3213         match events[0] {
3214                 Event::PaymentFailed { ref payment_hash, .. } => {
3215                         assert_eq!(*payment_hash, fourth_payment_hash);
3216                 },
3217                 _ => panic!("Unexpected event"),
3218         }
3219         if !deliver_bs_raa {
3220                 match events[1] {
3221                         Event::PendingHTLCsForwardable { .. } => { },
3222                         _ => panic!("Unexpected event"),
3223                 };
3224         }
3225         nodes[1].node.process_pending_htlc_forwards();
3226         check_added_monitors!(nodes[1], 1);
3227
3228         let events = nodes[1].node.get_and_clear_pending_msg_events();
3229         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3230         match events[if deliver_bs_raa { 1 } else { 0 }] {
3231                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3232                 _ => panic!("Unexpected event"),
3233         }
3234         match events[if deliver_bs_raa { 2 } else { 1 }] {
3235                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3236                         assert_eq!(channel_id, chan_2.2);
3237                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3238                 },
3239                 _ => panic!("Unexpected event"),
3240         }
3241         if deliver_bs_raa {
3242                 match events[0] {
3243                         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, .. } } => {
3244                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3245                                 assert_eq!(update_add_htlcs.len(), 1);
3246                                 assert!(update_fulfill_htlcs.is_empty());
3247                                 assert!(update_fail_htlcs.is_empty());
3248                                 assert!(update_fail_malformed_htlcs.is_empty());
3249                         },
3250                         _ => panic!("Unexpected event"),
3251                 }
3252         }
3253         match events[if deliver_bs_raa { 3 } else { 2 }] {
3254                 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, .. } } => {
3255                         assert!(update_add_htlcs.is_empty());
3256                         assert_eq!(update_fail_htlcs.len(), 3);
3257                         assert!(update_fulfill_htlcs.is_empty());
3258                         assert!(update_fail_malformed_htlcs.is_empty());
3259                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3260
3261                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3262                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3263                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3264
3265                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3266
3267                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3268                         // If we delivered B's RAA we got an unknown preimage error, not something
3269                         // that we should update our routing table for.
3270                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3271                         for event in events {
3272                                 match event {
3273                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3274                                         _ => panic!("Unexpected event"),
3275                                 }
3276                         }
3277                         let events = nodes[0].node.get_and_clear_pending_events();
3278                         assert_eq!(events.len(), 3);
3279                         match events[0] {
3280                                 Event::PaymentFailed { ref payment_hash, .. } => {
3281                                         assert!(failed_htlcs.insert(payment_hash.0));
3282                                 },
3283                                 _ => panic!("Unexpected event"),
3284                         }
3285                         match events[1] {
3286                                 Event::PaymentFailed { ref payment_hash, .. } => {
3287                                         assert!(failed_htlcs.insert(payment_hash.0));
3288                                 },
3289                                 _ => panic!("Unexpected event"),
3290                         }
3291                         match events[2] {
3292                                 Event::PaymentFailed { ref payment_hash, .. } => {
3293                                         assert!(failed_htlcs.insert(payment_hash.0));
3294                                 },
3295                                 _ => panic!("Unexpected event"),
3296                         }
3297                 },
3298                 _ => panic!("Unexpected event"),
3299         }
3300
3301         assert!(failed_htlcs.contains(&first_payment_hash.0));
3302         assert!(failed_htlcs.contains(&second_payment_hash.0));
3303         assert!(failed_htlcs.contains(&third_payment_hash.0));
3304 }
3305
3306 #[test]
3307 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3308         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3309         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3310         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3311         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3312 }
3313
3314 #[test]
3315 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3316         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3317         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3318         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3319         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3320 }
3321
3322 #[test]
3323 fn fail_backward_pending_htlc_upon_channel_failure() {
3324         let chanmon_cfgs = create_chanmon_cfgs(2);
3325         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3326         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3327         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3328         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3329         let logger = test_utils::TestLogger::new();
3330
3331         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3332         {
3333                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3334                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3335                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3336                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3337                 check_added_monitors!(nodes[0], 1);
3338
3339                 let payment_event = {
3340                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3341                         assert_eq!(events.len(), 1);
3342                         SendEvent::from_event(events.remove(0))
3343                 };
3344                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3345                 assert_eq!(payment_event.msgs.len(), 1);
3346         }
3347
3348         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3349         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3350         {
3351                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3352                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3353                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3354                 check_added_monitors!(nodes[0], 0);
3355
3356                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3357         }
3358
3359         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3360         {
3361                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3362
3363                 let secp_ctx = Secp256k1::new();
3364                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3365                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3366                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3367                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3368                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3369                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3370                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3371
3372                 // Send a 0-msat update_add_htlc to fail the channel.
3373                 let update_add_htlc = msgs::UpdateAddHTLC {
3374                         channel_id: chan.2,
3375                         htlc_id: 0,
3376                         amount_msat: 0,
3377                         payment_hash,
3378                         cltv_expiry,
3379                         onion_routing_packet,
3380                 };
3381                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3382         }
3383
3384         // Check that Alice fails backward the pending HTLC from the second payment.
3385         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3386         check_closed_broadcast!(nodes[0], true);
3387         check_added_monitors!(nodes[0], 1);
3388 }
3389
3390 #[test]
3391 fn test_htlc_ignore_latest_remote_commitment() {
3392         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3393         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3394         let chanmon_cfgs = create_chanmon_cfgs(2);
3395         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3396         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3397         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3398         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3399
3400         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3401         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3402         check_closed_broadcast!(nodes[0], true);
3403         check_added_monitors!(nodes[0], 1);
3404
3405         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3406         assert_eq!(node_txn.len(), 2);
3407
3408         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3409         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3410         check_closed_broadcast!(nodes[1], true);
3411         check_added_monitors!(nodes[1], 1);
3412
3413         // Duplicate the connect_block call since this may happen due to other listeners
3414         // registering new transactions
3415         header.prev_blockhash = header.block_hash();
3416         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3417 }
3418
3419 #[test]
3420 fn test_force_close_fail_back() {
3421         // Check which HTLCs are failed-backwards on channel force-closure
3422         let chanmon_cfgs = create_chanmon_cfgs(3);
3423         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3424         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3425         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3426         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3427         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3428         let logger = test_utils::TestLogger::new();
3429
3430         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3431
3432         let mut payment_event = {
3433                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3434                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3435                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3436                 check_added_monitors!(nodes[0], 1);
3437
3438                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3439                 assert_eq!(events.len(), 1);
3440                 SendEvent::from_event(events.remove(0))
3441         };
3442
3443         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3444         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3445
3446         expect_pending_htlcs_forwardable!(nodes[1]);
3447
3448         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3449         assert_eq!(events_2.len(), 1);
3450         payment_event = SendEvent::from_event(events_2.remove(0));
3451         assert_eq!(payment_event.msgs.len(), 1);
3452
3453         check_added_monitors!(nodes[1], 1);
3454         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3455         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3456         check_added_monitors!(nodes[2], 1);
3457         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3458
3459         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3460         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3461         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3462
3463         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3464         check_closed_broadcast!(nodes[2], true);
3465         check_added_monitors!(nodes[2], 1);
3466         let tx = {
3467                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3468                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3469                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3470                 // back to nodes[1] upon timeout otherwise.
3471                 assert_eq!(node_txn.len(), 1);
3472                 node_txn.remove(0)
3473         };
3474
3475         mine_transaction(&nodes[1], &tx);
3476
3477         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3478         check_closed_broadcast!(nodes[1], true);
3479         check_added_monitors!(nodes[1], 1);
3480
3481         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3482         {
3483                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3484                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3485                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3486         }
3487         mine_transaction(&nodes[2], &tx);
3488         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3489         assert_eq!(node_txn.len(), 1);
3490         assert_eq!(node_txn[0].input.len(), 1);
3491         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3492         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3493         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3494
3495         check_spends!(node_txn[0], tx);
3496 }
3497
3498 #[test]
3499 fn test_simple_peer_disconnect() {
3500         // Test that we can reconnect when there are no lost messages
3501         let chanmon_cfgs = create_chanmon_cfgs(3);
3502         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3503         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3504         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3505         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3506         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3507
3508         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3509         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3510         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3511
3512         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3513         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3514         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3515         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
3516
3517         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3518         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3519         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3520
3521         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3522         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3523         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3524         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3525
3526         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3527         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3528
3529         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3);
3530         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3531
3532         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3533         {
3534                 let events = nodes[0].node.get_and_clear_pending_events();
3535                 assert_eq!(events.len(), 2);
3536                 match events[0] {
3537                         Event::PaymentSent { payment_preimage } => {
3538                                 assert_eq!(payment_preimage, payment_preimage_3);
3539                         },
3540                         _ => panic!("Unexpected event"),
3541                 }
3542                 match events[1] {
3543                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3544                                 assert_eq!(payment_hash, payment_hash_5);
3545                                 assert!(rejected_by_dest);
3546                         },
3547                         _ => panic!("Unexpected event"),
3548                 }
3549         }
3550
3551         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
3552         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3553 }
3554
3555 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3556         // Test that we can reconnect when in-flight HTLC updates get dropped
3557         let chanmon_cfgs = create_chanmon_cfgs(2);
3558         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3559         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3560         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3561         if messages_delivered == 0 {
3562                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3563                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3564         } else {
3565                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3566         }
3567
3568         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3569
3570         let logger = test_utils::TestLogger::new();
3571         let payment_event = {
3572                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3573                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3574                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3575                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3576                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3577                 check_added_monitors!(nodes[0], 1);
3578
3579                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3580                 assert_eq!(events.len(), 1);
3581                 SendEvent::from_event(events.remove(0))
3582         };
3583         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3584
3585         if messages_delivered < 2 {
3586                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3587         } else {
3588                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3589                 if messages_delivered >= 3 {
3590                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3591                         check_added_monitors!(nodes[1], 1);
3592                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3593
3594                         if messages_delivered >= 4 {
3595                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3596                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3597                                 check_added_monitors!(nodes[0], 1);
3598
3599                                 if messages_delivered >= 5 {
3600                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3601                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3602                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3603                                         check_added_monitors!(nodes[0], 1);
3604
3605                                         if messages_delivered >= 6 {
3606                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3607                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3608                                                 check_added_monitors!(nodes[1], 1);
3609                                         }
3610                                 }
3611                         }
3612                 }
3613         }
3614
3615         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3616         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3617         if messages_delivered < 3 {
3618                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3619                 // received on either side, both sides will need to resend them.
3620                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3621         } else if messages_delivered == 3 {
3622                 // nodes[0] still wants its RAA + commitment_signed
3623                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3624         } else if messages_delivered == 4 {
3625                 // nodes[0] still wants its commitment_signed
3626                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3627         } else if messages_delivered == 5 {
3628                 // nodes[1] still wants its final RAA
3629                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3630         } else if messages_delivered == 6 {
3631                 // Everything was delivered...
3632                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3633         }
3634
3635         let events_1 = nodes[1].node.get_and_clear_pending_events();
3636         assert_eq!(events_1.len(), 1);
3637         match events_1[0] {
3638                 Event::PendingHTLCsForwardable { .. } => { },
3639                 _ => panic!("Unexpected event"),
3640         };
3641
3642         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3643         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3644         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3645
3646         nodes[1].node.process_pending_htlc_forwards();
3647
3648         let events_2 = nodes[1].node.get_and_clear_pending_events();
3649         assert_eq!(events_2.len(), 1);
3650         match events_2[0] {
3651                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
3652                         assert_eq!(payment_hash_1, *payment_hash);
3653                         assert!(payment_preimage.is_none());
3654                         assert_eq!(payment_secret_1, *payment_secret);
3655                         assert_eq!(amt, 1000000);
3656                 },
3657                 _ => panic!("Unexpected event"),
3658         }
3659
3660         nodes[1].node.claim_funds(payment_preimage_1);
3661         check_added_monitors!(nodes[1], 1);
3662
3663         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3664         assert_eq!(events_3.len(), 1);
3665         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3666                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3667                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3668                         assert!(updates.update_add_htlcs.is_empty());
3669                         assert!(updates.update_fail_htlcs.is_empty());
3670                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3671                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3672                         assert!(updates.update_fee.is_none());
3673                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3674                 },
3675                 _ => panic!("Unexpected event"),
3676         };
3677
3678         if messages_delivered >= 1 {
3679                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3680
3681                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3682                 assert_eq!(events_4.len(), 1);
3683                 match events_4[0] {
3684                         Event::PaymentSent { ref payment_preimage } => {
3685                                 assert_eq!(payment_preimage_1, *payment_preimage);
3686                         },
3687                         _ => panic!("Unexpected event"),
3688                 }
3689
3690                 if messages_delivered >= 2 {
3691                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3692                         check_added_monitors!(nodes[0], 1);
3693                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3694
3695                         if messages_delivered >= 3 {
3696                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3697                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3698                                 check_added_monitors!(nodes[1], 1);
3699
3700                                 if messages_delivered >= 4 {
3701                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3702                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3703                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3704                                         check_added_monitors!(nodes[1], 1);
3705
3706                                         if messages_delivered >= 5 {
3707                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3708                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3709                                                 check_added_monitors!(nodes[0], 1);
3710                                         }
3711                                 }
3712                         }
3713                 }
3714         }
3715
3716         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3717         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3718         if messages_delivered < 2 {
3719                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3720                 //TODO: Deduplicate PaymentSent events, then enable this if:
3721                 //if messages_delivered < 1 {
3722                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3723                         assert_eq!(events_4.len(), 1);
3724                         match events_4[0] {
3725                                 Event::PaymentSent { ref payment_preimage } => {
3726                                         assert_eq!(payment_preimage_1, *payment_preimage);
3727                                 },
3728                                 _ => panic!("Unexpected event"),
3729                         }
3730                 //}
3731         } else if messages_delivered == 2 {
3732                 // nodes[0] still wants its RAA + commitment_signed
3733                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3734         } else if messages_delivered == 3 {
3735                 // nodes[0] still wants its commitment_signed
3736                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3737         } else if messages_delivered == 4 {
3738                 // nodes[1] still wants its final RAA
3739                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3740         } else if messages_delivered == 5 {
3741                 // Everything was delivered...
3742                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3743         }
3744
3745         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3746         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3747         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3748
3749         // Channel should still work fine...
3750         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3751         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3752                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3753                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3754         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3755         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
3756 }
3757
3758 #[test]
3759 fn test_drop_messages_peer_disconnect_a() {
3760         do_test_drop_messages_peer_disconnect(0);
3761         do_test_drop_messages_peer_disconnect(1);
3762         do_test_drop_messages_peer_disconnect(2);
3763         do_test_drop_messages_peer_disconnect(3);
3764 }
3765
3766 #[test]
3767 fn test_drop_messages_peer_disconnect_b() {
3768         do_test_drop_messages_peer_disconnect(4);
3769         do_test_drop_messages_peer_disconnect(5);
3770         do_test_drop_messages_peer_disconnect(6);
3771 }
3772
3773 #[test]
3774 fn test_funding_peer_disconnect() {
3775         // Test that we can lock in our funding tx while disconnected
3776         let chanmon_cfgs = create_chanmon_cfgs(2);
3777         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3778         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3779         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3780         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3781
3782         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3783         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3784
3785         confirm_transaction(&nodes[0], &tx);
3786         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3787         assert_eq!(events_1.len(), 1);
3788         match events_1[0] {
3789                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3790                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3791                 },
3792                 _ => panic!("Unexpected event"),
3793         }
3794
3795         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3796
3797         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3798         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3799
3800         confirm_transaction(&nodes[1], &tx);
3801         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3802         assert_eq!(events_2.len(), 2);
3803         let funding_locked = match events_2[0] {
3804                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3805                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3806                         msg.clone()
3807                 },
3808                 _ => panic!("Unexpected event"),
3809         };
3810         let bs_announcement_sigs = match events_2[1] {
3811                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3812                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3813                         msg.clone()
3814                 },
3815                 _ => panic!("Unexpected event"),
3816         };
3817
3818         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3819
3820         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3821         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3822         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3823         assert_eq!(events_3.len(), 2);
3824         let as_announcement_sigs = match events_3[0] {
3825                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3826                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3827                         msg.clone()
3828                 },
3829                 _ => panic!("Unexpected event"),
3830         };
3831         let (as_announcement, as_update) = match events_3[1] {
3832                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3833                         (msg.clone(), update_msg.clone())
3834                 },
3835                 _ => panic!("Unexpected event"),
3836         };
3837
3838         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3839         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3840         assert_eq!(events_4.len(), 1);
3841         let (_, bs_update) = match events_4[0] {
3842                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3843                         (msg.clone(), update_msg.clone())
3844                 },
3845                 _ => panic!("Unexpected event"),
3846         };
3847
3848         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3849         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3850         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3851
3852         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3853         let logger = test_utils::TestLogger::new();
3854         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3855         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3856         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
3857 }
3858
3859 #[test]
3860 fn test_drop_messages_peer_disconnect_dual_htlc() {
3861         // Test that we can handle reconnecting when both sides of a channel have pending
3862         // commitment_updates when we disconnect.
3863         let chanmon_cfgs = create_chanmon_cfgs(2);
3864         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3865         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3866         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3867         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3868         let logger = test_utils::TestLogger::new();
3869
3870         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3871
3872         // Now try to send a second payment which will fail to send
3873         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3874         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3875         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3876         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3877         check_added_monitors!(nodes[0], 1);
3878
3879         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3880         assert_eq!(events_1.len(), 1);
3881         match events_1[0] {
3882                 MessageSendEvent::UpdateHTLCs { .. } => {},
3883                 _ => panic!("Unexpected event"),
3884         }
3885
3886         assert!(nodes[1].node.claim_funds(payment_preimage_1));
3887         check_added_monitors!(nodes[1], 1);
3888
3889         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3890         assert_eq!(events_2.len(), 1);
3891         match events_2[0] {
3892                 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 } } => {
3893                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3894                         assert!(update_add_htlcs.is_empty());
3895                         assert_eq!(update_fulfill_htlcs.len(), 1);
3896                         assert!(update_fail_htlcs.is_empty());
3897                         assert!(update_fail_malformed_htlcs.is_empty());
3898                         assert!(update_fee.is_none());
3899
3900                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3901                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3902                         assert_eq!(events_3.len(), 1);
3903                         match events_3[0] {
3904                                 Event::PaymentSent { ref payment_preimage } => {
3905                                         assert_eq!(*payment_preimage, payment_preimage_1);
3906                                 },
3907                                 _ => panic!("Unexpected event"),
3908                         }
3909
3910                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3911                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3912                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3913                         check_added_monitors!(nodes[0], 1);
3914                 },
3915                 _ => panic!("Unexpected event"),
3916         }
3917
3918         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3919         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3920
3921         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3922         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3923         assert_eq!(reestablish_1.len(), 1);
3924         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3925         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3926         assert_eq!(reestablish_2.len(), 1);
3927
3928         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3929         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3930         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3931         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3932
3933         assert!(as_resp.0.is_none());
3934         assert!(bs_resp.0.is_none());
3935
3936         assert!(bs_resp.1.is_none());
3937         assert!(bs_resp.2.is_none());
3938
3939         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3940
3941         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3942         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3943         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3944         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3945         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3946         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3947         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3948         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3949         // No commitment_signed so get_event_msg's assert(len == 1) passes
3950         check_added_monitors!(nodes[1], 1);
3951
3952         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3953         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3954         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3955         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3956         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3957         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3958         assert!(bs_second_commitment_signed.update_fee.is_none());
3959         check_added_monitors!(nodes[1], 1);
3960
3961         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3962         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3963         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3964         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3965         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3966         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3967         assert!(as_commitment_signed.update_fee.is_none());
3968         check_added_monitors!(nodes[0], 1);
3969
3970         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3971         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3972         // No commitment_signed so get_event_msg's assert(len == 1) passes
3973         check_added_monitors!(nodes[0], 1);
3974
3975         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3976         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3977         // No commitment_signed so get_event_msg's assert(len == 1) passes
3978         check_added_monitors!(nodes[1], 1);
3979
3980         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3981         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3982         check_added_monitors!(nodes[1], 1);
3983
3984         expect_pending_htlcs_forwardable!(nodes[1]);
3985
3986         let events_5 = nodes[1].node.get_and_clear_pending_events();
3987         assert_eq!(events_5.len(), 1);
3988         match events_5[0] {
3989                 Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt: _, user_payment_id: _ } => {
3990                         assert_eq!(payment_hash_2, *payment_hash);
3991                         assert!(payment_preimage.is_none());
3992                         assert_eq!(payment_secret_2, *payment_secret);
3993                 },
3994                 _ => panic!("Unexpected event"),
3995         }
3996
3997         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3998         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3999         check_added_monitors!(nodes[0], 1);
4000
4001         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
4002 }
4003
4004 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4005         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4006         // to avoid our counterparty failing the channel.
4007         let chanmon_cfgs = create_chanmon_cfgs(2);
4008         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4009         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4010         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4011
4012         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4013         let logger = test_utils::TestLogger::new();
4014
4015         let our_payment_hash = if send_partial_mpp {
4016                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4017                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4018                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4019                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4020                 // indicates there are more HTLCs coming.
4021                 let cur_height = CHAN_CONFIRM_DEPTH + 1; // route_payment calls send_payment, which adds 1 to the current height. So we do the same here to match.
4022                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4023                 check_added_monitors!(nodes[0], 1);
4024                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4025                 assert_eq!(events.len(), 1);
4026                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4027                 // hop should *not* yet generate any PaymentReceived event(s).
4028                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4029                 our_payment_hash
4030         } else {
4031                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4032         };
4033
4034         let mut block = Block {
4035                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4036                 txdata: vec![],
4037         };
4038         connect_block(&nodes[0], &block);
4039         connect_block(&nodes[1], &block);
4040         for _ in CHAN_CONFIRM_DEPTH + 2 ..TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4041                 block.header.prev_blockhash = block.block_hash();
4042                 connect_block(&nodes[0], &block);
4043                 connect_block(&nodes[1], &block);
4044         }
4045
4046         expect_pending_htlcs_forwardable!(nodes[1]);
4047
4048         check_added_monitors!(nodes[1], 1);
4049         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4050         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4051         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4052         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4053         assert!(htlc_timeout_updates.update_fee.is_none());
4054
4055         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4056         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4057         // 100_000 msat as u64, followed by a height of TEST_FINAL_CLTV + 2 as u32
4058         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4059         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(TEST_FINAL_CLTV + 2));
4060         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4061 }
4062
4063 #[test]
4064 fn test_htlc_timeout() {
4065         do_test_htlc_timeout(true);
4066         do_test_htlc_timeout(false);
4067 }
4068
4069 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4070         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4071         let chanmon_cfgs = create_chanmon_cfgs(3);
4072         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4073         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4074         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4075         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4076         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4077
4078         // Make sure all nodes are at the same starting height
4079         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4080         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4081         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4082
4083         let logger = test_utils::TestLogger::new();
4084
4085         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4086         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4087         {
4088                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4089                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4090                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4091         }
4092         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4093         check_added_monitors!(nodes[1], 1);
4094
4095         // Now attempt to route a second payment, which should be placed in the holding cell
4096         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4097         if forwarded_htlc {
4098                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4099                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4100                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4101                 check_added_monitors!(nodes[0], 1);
4102                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4103                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4104                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4105                 expect_pending_htlcs_forwardable!(nodes[1]);
4106                 check_added_monitors!(nodes[1], 0);
4107         } else {
4108                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4109                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4110                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4111                 check_added_monitors!(nodes[1], 0);
4112         }
4113
4114         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4115         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4116         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4117         connect_blocks(&nodes[1], 1);
4118
4119         if forwarded_htlc {
4120                 expect_pending_htlcs_forwardable!(nodes[1]);
4121                 check_added_monitors!(nodes[1], 1);
4122                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4123                 assert_eq!(fail_commit.len(), 1);
4124                 match fail_commit[0] {
4125                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4126                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4127                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4128                         },
4129                         _ => unreachable!(),
4130                 }
4131                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4132                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4133                         match update {
4134                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4135                                 _ => panic!("Unexpected event"),
4136                         }
4137                 } else {
4138                         panic!("Unexpected event");
4139                 }
4140         } else {
4141                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4142         }
4143 }
4144
4145 #[test]
4146 fn test_holding_cell_htlc_add_timeouts() {
4147         do_test_holding_cell_htlc_add_timeouts(false);
4148         do_test_holding_cell_htlc_add_timeouts(true);
4149 }
4150
4151 #[test]
4152 fn test_invalid_channel_announcement() {
4153         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4154         let secp_ctx = Secp256k1::new();
4155         let chanmon_cfgs = create_chanmon_cfgs(2);
4156         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4157         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4158         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4159
4160         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4161
4162         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4163         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4164         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4165         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4166
4167         nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4168
4169         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4170         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4171
4172         let as_network_key = nodes[0].node.get_our_node_id();
4173         let bs_network_key = nodes[1].node.get_our_node_id();
4174
4175         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4176
4177         let mut chan_announcement;
4178
4179         macro_rules! dummy_unsigned_msg {
4180                 () => {
4181                         msgs::UnsignedChannelAnnouncement {
4182                                 features: ChannelFeatures::known(),
4183                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4184                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4185                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4186                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4187                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4188                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4189                                 excess_data: Vec::new(),
4190                         };
4191                 }
4192         }
4193
4194         macro_rules! sign_msg {
4195                 ($unsigned_msg: expr) => {
4196                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4197                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4198                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4199                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4200                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4201                         chan_announcement = msgs::ChannelAnnouncement {
4202                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4203                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4204                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4205                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4206                                 contents: $unsigned_msg
4207                         }
4208                 }
4209         }
4210
4211         let unsigned_msg = dummy_unsigned_msg!();
4212         sign_msg!(unsigned_msg);
4213         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4214         let _ = nodes[0].net_graph_msg_handler.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
4215
4216         // Configured with Network::Testnet
4217         let mut unsigned_msg = dummy_unsigned_msg!();
4218         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4219         sign_msg!(unsigned_msg);
4220         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4221
4222         let mut unsigned_msg = dummy_unsigned_msg!();
4223         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4224         sign_msg!(unsigned_msg);
4225         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4226 }
4227
4228 #[test]
4229 fn test_no_txn_manager_serialize_deserialize() {
4230         let chanmon_cfgs = create_chanmon_cfgs(2);
4231         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4232         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4233         let logger: test_utils::TestLogger;
4234         let fee_estimator: test_utils::TestFeeEstimator;
4235         let persister: test_utils::TestPersister;
4236         let new_chain_monitor: test_utils::TestChainMonitor;
4237         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4238         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4239
4240         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4241
4242         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4243
4244         let nodes_0_serialized = nodes[0].node.encode();
4245         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4246         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4247
4248         logger = test_utils::TestLogger::new();
4249         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4250         persister = test_utils::TestPersister::new();
4251         let keys_manager = &chanmon_cfgs[0].keys_manager;
4252         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4253         nodes[0].chain_monitor = &new_chain_monitor;
4254         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4255         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4256                 &mut chan_0_monitor_read, keys_manager).unwrap();
4257         assert!(chan_0_monitor_read.is_empty());
4258
4259         let mut nodes_0_read = &nodes_0_serialized[..];
4260         let config = UserConfig::default();
4261         let (_, nodes_0_deserialized_tmp) = {
4262                 let mut channel_monitors = HashMap::new();
4263                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4264                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4265                         default_config: config,
4266                         keys_manager,
4267                         fee_estimator: &fee_estimator,
4268                         chain_monitor: nodes[0].chain_monitor,
4269                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4270                         logger: &logger,
4271                         channel_monitors,
4272                 }).unwrap()
4273         };
4274         nodes_0_deserialized = nodes_0_deserialized_tmp;
4275         assert!(nodes_0_read.is_empty());
4276
4277         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4278         nodes[0].node = &nodes_0_deserialized;
4279         assert_eq!(nodes[0].node.list_channels().len(), 1);
4280         check_added_monitors!(nodes[0], 1);
4281
4282         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4283         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4284         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4285         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4286
4287         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4288         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4289         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4290         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4291
4292         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4293         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4294         for node in nodes.iter() {
4295                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4296                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4297                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4298         }
4299
4300         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4301 }
4302
4303 #[test]
4304 fn test_manager_serialize_deserialize_events() {
4305         // This test makes sure the events field in ChannelManager survives de/serialization
4306         let chanmon_cfgs = create_chanmon_cfgs(2);
4307         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4308         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4309         let fee_estimator: test_utils::TestFeeEstimator;
4310         let persister: test_utils::TestPersister;
4311         let logger: test_utils::TestLogger;
4312         let new_chain_monitor: test_utils::TestChainMonitor;
4313         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4314         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4315
4316         // Start creating a channel, but stop right before broadcasting the funding transaction
4317         let channel_value = 100000;
4318         let push_msat = 10001;
4319         let a_flags = InitFeatures::known();
4320         let b_flags = InitFeatures::known();
4321         let node_a = nodes.remove(0);
4322         let node_b = nodes.remove(0);
4323         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4324         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
4325         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
4326
4327         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4328
4329         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4330         check_added_monitors!(node_a, 0);
4331
4332         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
4333         {
4334                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4335                 assert_eq!(added_monitors.len(), 1);
4336                 assert_eq!(added_monitors[0].0, funding_output);
4337                 added_monitors.clear();
4338         }
4339
4340         node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id()));
4341         {
4342                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4343                 assert_eq!(added_monitors.len(), 1);
4344                 assert_eq!(added_monitors[0].0, funding_output);
4345                 added_monitors.clear();
4346         }
4347         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4348
4349         nodes.push(node_a);
4350         nodes.push(node_b);
4351
4352         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4353         let nodes_0_serialized = nodes[0].node.encode();
4354         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4355         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4356
4357         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4358         logger = test_utils::TestLogger::new();
4359         persister = test_utils::TestPersister::new();
4360         let keys_manager = &chanmon_cfgs[0].keys_manager;
4361         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4362         nodes[0].chain_monitor = &new_chain_monitor;
4363         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4364         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4365                 &mut chan_0_monitor_read, keys_manager).unwrap();
4366         assert!(chan_0_monitor_read.is_empty());
4367
4368         let mut nodes_0_read = &nodes_0_serialized[..];
4369         let config = UserConfig::default();
4370         let (_, nodes_0_deserialized_tmp) = {
4371                 let mut channel_monitors = HashMap::new();
4372                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4373                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4374                         default_config: config,
4375                         keys_manager,
4376                         fee_estimator: &fee_estimator,
4377                         chain_monitor: nodes[0].chain_monitor,
4378                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4379                         logger: &logger,
4380                         channel_monitors,
4381                 }).unwrap()
4382         };
4383         nodes_0_deserialized = nodes_0_deserialized_tmp;
4384         assert!(nodes_0_read.is_empty());
4385
4386         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4387
4388         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4389         nodes[0].node = &nodes_0_deserialized;
4390
4391         // After deserializing, make sure the funding_transaction is still held by the channel manager
4392         let events_4 = nodes[0].node.get_and_clear_pending_events();
4393         assert_eq!(events_4.len(), 0);
4394         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4395         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4396
4397         // Make sure the channel is functioning as though the de/serialization never happened
4398         assert_eq!(nodes[0].node.list_channels().len(), 1);
4399         check_added_monitors!(nodes[0], 1);
4400
4401         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4402         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4403         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4404         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4405
4406         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4407         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4408         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4409         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4410
4411         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4412         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4413         for node in nodes.iter() {
4414                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4415                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4416                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4417         }
4418
4419         send_payment(&nodes[0], &[&nodes[1]], 1000000);
4420 }
4421
4422 #[test]
4423 fn test_simple_manager_serialize_deserialize() {
4424         let chanmon_cfgs = create_chanmon_cfgs(2);
4425         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4426         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4427         let logger: test_utils::TestLogger;
4428         let fee_estimator: test_utils::TestFeeEstimator;
4429         let persister: test_utils::TestPersister;
4430         let new_chain_monitor: test_utils::TestChainMonitor;
4431         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4432         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4433         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4434
4435         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4436         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4437
4438         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4439
4440         let nodes_0_serialized = nodes[0].node.encode();
4441         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4442         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4443
4444         logger = test_utils::TestLogger::new();
4445         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4446         persister = test_utils::TestPersister::new();
4447         let keys_manager = &chanmon_cfgs[0].keys_manager;
4448         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4449         nodes[0].chain_monitor = &new_chain_monitor;
4450         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4451         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4452                 &mut chan_0_monitor_read, keys_manager).unwrap();
4453         assert!(chan_0_monitor_read.is_empty());
4454
4455         let mut nodes_0_read = &nodes_0_serialized[..];
4456         let (_, nodes_0_deserialized_tmp) = {
4457                 let mut channel_monitors = HashMap::new();
4458                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4459                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4460                         default_config: UserConfig::default(),
4461                         keys_manager,
4462                         fee_estimator: &fee_estimator,
4463                         chain_monitor: nodes[0].chain_monitor,
4464                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4465                         logger: &logger,
4466                         channel_monitors,
4467                 }).unwrap()
4468         };
4469         nodes_0_deserialized = nodes_0_deserialized_tmp;
4470         assert!(nodes_0_read.is_empty());
4471
4472         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4473         nodes[0].node = &nodes_0_deserialized;
4474         check_added_monitors!(nodes[0], 1);
4475
4476         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4477
4478         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4479         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
4480 }
4481
4482 #[test]
4483 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4484         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4485         let chanmon_cfgs = create_chanmon_cfgs(4);
4486         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4487         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4488         let logger: test_utils::TestLogger;
4489         let fee_estimator: test_utils::TestFeeEstimator;
4490         let persister: test_utils::TestPersister;
4491         let new_chain_monitor: test_utils::TestChainMonitor;
4492         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4493         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4494         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4495         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4496         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4497
4498         let mut node_0_stale_monitors_serialized = Vec::new();
4499         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4500                 let mut writer = test_utils::TestVecWriter(Vec::new());
4501                 monitor.1.write(&mut writer).unwrap();
4502                 node_0_stale_monitors_serialized.push(writer.0);
4503         }
4504
4505         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4506
4507         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4508         let nodes_0_serialized = nodes[0].node.encode();
4509
4510         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4511         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4512         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4513         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4514
4515         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4516         // nodes[3])
4517         let mut node_0_monitors_serialized = Vec::new();
4518         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4519                 let mut writer = test_utils::TestVecWriter(Vec::new());
4520                 monitor.1.write(&mut writer).unwrap();
4521                 node_0_monitors_serialized.push(writer.0);
4522         }
4523
4524         logger = test_utils::TestLogger::new();
4525         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4526         persister = test_utils::TestPersister::new();
4527         let keys_manager = &chanmon_cfgs[0].keys_manager;
4528         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4529         nodes[0].chain_monitor = &new_chain_monitor;
4530
4531
4532         let mut node_0_stale_monitors = Vec::new();
4533         for serialized in node_0_stale_monitors_serialized.iter() {
4534                 let mut read = &serialized[..];
4535                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4536                 assert!(read.is_empty());
4537                 node_0_stale_monitors.push(monitor);
4538         }
4539
4540         let mut node_0_monitors = Vec::new();
4541         for serialized in node_0_monitors_serialized.iter() {
4542                 let mut read = &serialized[..];
4543                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4544                 assert!(read.is_empty());
4545                 node_0_monitors.push(monitor);
4546         }
4547
4548         let mut nodes_0_read = &nodes_0_serialized[..];
4549         if let Err(msgs::DecodeError::InvalidValue) =
4550                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4551                 default_config: UserConfig::default(),
4552                 keys_manager,
4553                 fee_estimator: &fee_estimator,
4554                 chain_monitor: nodes[0].chain_monitor,
4555                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4556                 logger: &logger,
4557                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4558         }) { } else {
4559                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4560         };
4561
4562         let mut nodes_0_read = &nodes_0_serialized[..];
4563         let (_, nodes_0_deserialized_tmp) =
4564                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4565                 default_config: UserConfig::default(),
4566                 keys_manager,
4567                 fee_estimator: &fee_estimator,
4568                 chain_monitor: nodes[0].chain_monitor,
4569                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4570                 logger: &logger,
4571                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4572         }).unwrap();
4573         nodes_0_deserialized = nodes_0_deserialized_tmp;
4574         assert!(nodes_0_read.is_empty());
4575
4576         { // Channel close should result in a commitment tx and an HTLC tx
4577                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4578                 assert_eq!(txn.len(), 2);
4579                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4580                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4581         }
4582
4583         for monitor in node_0_monitors.drain(..) {
4584                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4585                 check_added_monitors!(nodes[0], 1);
4586         }
4587         nodes[0].node = &nodes_0_deserialized;
4588
4589         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4590         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4591         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4592         //... and we can even still claim the payment!
4593         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
4594
4595         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4596         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4597         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4598         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4599         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4600         assert_eq!(msg_events.len(), 1);
4601         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4602                 match action {
4603                         &ErrorAction::SendErrorMessage { ref msg } => {
4604                                 assert_eq!(msg.channel_id, channel_id);
4605                         },
4606                         _ => panic!("Unexpected event!"),
4607                 }
4608         }
4609 }
4610
4611 macro_rules! check_spendable_outputs {
4612         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4613                 {
4614                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4615                         let mut txn = Vec::new();
4616                         let mut all_outputs = Vec::new();
4617                         let secp_ctx = Secp256k1::new();
4618                         for event in events.drain(..) {
4619                                 match event {
4620                                         Event::SpendableOutputs { mut outputs } => {
4621                                                 for outp in outputs.drain(..) {
4622                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4623                                                         all_outputs.push(outp);
4624                                                 }
4625                                         },
4626                                         _ => panic!("Unexpected event"),
4627                                 };
4628                         }
4629                         if all_outputs.len() > 1 {
4630                                 if let Ok(tx) = $keysinterface.backing.spend_spendable_outputs(&all_outputs.iter().map(|a| a).collect::<Vec<_>>(), Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx) {
4631                                         txn.push(tx);
4632                                 }
4633                         }
4634                         txn
4635                 }
4636         }
4637 }
4638
4639 #[test]
4640 fn test_claim_sizeable_push_msat() {
4641         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4642         let chanmon_cfgs = create_chanmon_cfgs(2);
4643         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4644         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4645         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4646
4647         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4648         nodes[1].node.force_close_channel(&chan.2).unwrap();
4649         check_closed_broadcast!(nodes[1], true);
4650         check_added_monitors!(nodes[1], 1);
4651         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4652         assert_eq!(node_txn.len(), 1);
4653         check_spends!(node_txn[0], chan.3);
4654         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
4655
4656         mine_transaction(&nodes[1], &node_txn[0]);
4657         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4658
4659         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4660         assert_eq!(spend_txn.len(), 1);
4661         check_spends!(spend_txn[0], node_txn[0]);
4662 }
4663
4664 #[test]
4665 fn test_claim_on_remote_sizeable_push_msat() {
4666         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4667         // to_remote output is encumbered by a P2WPKH
4668         let chanmon_cfgs = create_chanmon_cfgs(2);
4669         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4670         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4671         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4672
4673         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4674         nodes[0].node.force_close_channel(&chan.2).unwrap();
4675         check_closed_broadcast!(nodes[0], true);
4676         check_added_monitors!(nodes[0], 1);
4677
4678         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4679         assert_eq!(node_txn.len(), 1);
4680         check_spends!(node_txn[0], chan.3);
4681         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
4682
4683         mine_transaction(&nodes[1], &node_txn[0]);
4684         check_closed_broadcast!(nodes[1], true);
4685         check_added_monitors!(nodes[1], 1);
4686         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4687
4688         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4689         assert_eq!(spend_txn.len(), 1);
4690         check_spends!(spend_txn[0], node_txn[0]);
4691 }
4692
4693 #[test]
4694 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4695         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4696         // to_remote output is encumbered by a P2WPKH
4697
4698         let chanmon_cfgs = create_chanmon_cfgs(2);
4699         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4700         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4701         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4702
4703         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4704         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4705         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4706         assert_eq!(revoked_local_txn[0].input.len(), 1);
4707         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4708
4709         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4710         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4711         check_closed_broadcast!(nodes[1], true);
4712         check_added_monitors!(nodes[1], 1);
4713
4714         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4715         mine_transaction(&nodes[1], &node_txn[0]);
4716         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4717
4718         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4719         assert_eq!(spend_txn.len(), 3);
4720         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4721         check_spends!(spend_txn[1], node_txn[0]);
4722         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4723 }
4724
4725 #[test]
4726 fn test_static_spendable_outputs_preimage_tx() {
4727         let chanmon_cfgs = create_chanmon_cfgs(2);
4728         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4729         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4730         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4731
4732         // Create some initial channels
4733         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4734
4735         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4736
4737         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4738         assert_eq!(commitment_tx[0].input.len(), 1);
4739         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4740
4741         // Settle A's commitment tx on B's chain
4742         assert!(nodes[1].node.claim_funds(payment_preimage));
4743         check_added_monitors!(nodes[1], 1);
4744         mine_transaction(&nodes[1], &commitment_tx[0]);
4745         check_added_monitors!(nodes[1], 1);
4746         let events = nodes[1].node.get_and_clear_pending_msg_events();
4747         match events[0] {
4748                 MessageSendEvent::UpdateHTLCs { .. } => {},
4749                 _ => panic!("Unexpected event"),
4750         }
4751         match events[1] {
4752                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4753                 _ => panic!("Unexepected event"),
4754         }
4755
4756         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4757         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4758         assert_eq!(node_txn.len(), 3);
4759         check_spends!(node_txn[0], commitment_tx[0]);
4760         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4761         check_spends!(node_txn[1], chan_1.3);
4762         check_spends!(node_txn[2], node_txn[1]);
4763
4764         mine_transaction(&nodes[1], &node_txn[0]);
4765         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4766
4767         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4768         assert_eq!(spend_txn.len(), 1);
4769         check_spends!(spend_txn[0], node_txn[0]);
4770 }
4771
4772 #[test]
4773 fn test_static_spendable_outputs_timeout_tx() {
4774         let chanmon_cfgs = create_chanmon_cfgs(2);
4775         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4776         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4777         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4778
4779         // Create some initial channels
4780         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4781
4782         // Rebalance the network a bit by relaying one payment through all the channels ...
4783         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4784
4785         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4786
4787         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4788         assert_eq!(commitment_tx[0].input.len(), 1);
4789         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4790
4791         // Settle A's commitment tx on B' chain
4792         mine_transaction(&nodes[1], &commitment_tx[0]);
4793         check_added_monitors!(nodes[1], 1);
4794         let events = nodes[1].node.get_and_clear_pending_msg_events();
4795         match events[0] {
4796                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4797                 _ => panic!("Unexpected event"),
4798         }
4799
4800         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4801         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4802         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4803         check_spends!(node_txn[0],  commitment_tx[0].clone());
4804         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4805         check_spends!(node_txn[1], chan_1.3.clone());
4806         check_spends!(node_txn[2], node_txn[1]);
4807
4808         mine_transaction(&nodes[1], &node_txn[0]);
4809         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4810         expect_payment_failed!(nodes[1], our_payment_hash, true);
4811
4812         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4813         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4814         check_spends!(spend_txn[0], commitment_tx[0]);
4815         check_spends!(spend_txn[1], node_txn[0]);
4816         check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
4817 }
4818
4819 #[test]
4820 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4821         let chanmon_cfgs = create_chanmon_cfgs(2);
4822         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4823         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4824         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4825
4826         // Create some initial channels
4827         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4828
4829         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4830         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4831         assert_eq!(revoked_local_txn[0].input.len(), 1);
4832         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4833
4834         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4835
4836         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4837         check_closed_broadcast!(nodes[1], true);
4838         check_added_monitors!(nodes[1], 1);
4839
4840         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4841         assert_eq!(node_txn.len(), 2);
4842         assert_eq!(node_txn[0].input.len(), 2);
4843         check_spends!(node_txn[0], revoked_local_txn[0]);
4844
4845         mine_transaction(&nodes[1], &node_txn[0]);
4846         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4847
4848         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4849         assert_eq!(spend_txn.len(), 1);
4850         check_spends!(spend_txn[0], node_txn[0]);
4851 }
4852
4853 #[test]
4854 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4855         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4856         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4857         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4858         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4859         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4860
4861         // Create some initial channels
4862         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4863
4864         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4865         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4866         assert_eq!(revoked_local_txn[0].input.len(), 1);
4867         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4868
4869         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4870
4871         // A will generate HTLC-Timeout from revoked commitment tx
4872         mine_transaction(&nodes[0], &revoked_local_txn[0]);
4873         check_closed_broadcast!(nodes[0], true);
4874         check_added_monitors!(nodes[0], 1);
4875
4876         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4877         assert_eq!(revoked_htlc_txn.len(), 2);
4878         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4879         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4880         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4881         check_spends!(revoked_htlc_txn[1], chan_1.3);
4882
4883         // B will generate justice tx from A's revoked commitment/HTLC tx
4884         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4885         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4886         check_closed_broadcast!(nodes[1], true);
4887         check_added_monitors!(nodes[1], 1);
4888
4889         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4890         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4891         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4892         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4893         // transactions next...
4894         assert_eq!(node_txn[0].input.len(), 3);
4895         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4896
4897         assert_eq!(node_txn[1].input.len(), 2);
4898         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
4899         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4900                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4901         } else {
4902                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4903                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4904         }
4905
4906         assert_eq!(node_txn[2].input.len(), 1);
4907         check_spends!(node_txn[2], chan_1.3);
4908
4909         mine_transaction(&nodes[1], &node_txn[1]);
4910         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4911
4912         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4913         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4914         assert_eq!(spend_txn.len(), 1);
4915         assert_eq!(spend_txn[0].input.len(), 1);
4916         check_spends!(spend_txn[0], node_txn[1]);
4917 }
4918
4919 #[test]
4920 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4921         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4922         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4923         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4924         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4925         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4926
4927         // Create some initial channels
4928         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4929
4930         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4931         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4932         assert_eq!(revoked_local_txn[0].input.len(), 1);
4933         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4934
4935         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4936         assert_eq!(revoked_local_txn[0].output.len(), 2);
4937
4938         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
4939
4940         // B will generate HTLC-Success from revoked commitment tx
4941         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4942         check_closed_broadcast!(nodes[1], true);
4943         check_added_monitors!(nodes[1], 1);
4944         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4945
4946         assert_eq!(revoked_htlc_txn.len(), 2);
4947         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4948         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4949         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4950
4951         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4952         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4953         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4954
4955         // A will generate justice tx from B's revoked commitment/HTLC tx
4956         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4957         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4958         check_closed_broadcast!(nodes[0], true);
4959         check_added_monitors!(nodes[0], 1);
4960
4961         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4962         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4963
4964         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4965         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4966         // transactions next...
4967         assert_eq!(node_txn[0].input.len(), 2);
4968         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4969         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4970                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4971         } else {
4972                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4973                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4974         }
4975
4976         assert_eq!(node_txn[1].input.len(), 1);
4977         check_spends!(node_txn[1], revoked_htlc_txn[0]);
4978
4979         check_spends!(node_txn[2], chan_1.3);
4980
4981         mine_transaction(&nodes[0], &node_txn[1]);
4982         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
4983
4984         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4985         // didn't try to generate any new transactions.
4986
4987         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4988         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
4989         assert_eq!(spend_txn.len(), 3);
4990         assert_eq!(spend_txn[0].input.len(), 1);
4991         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4992         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4993         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
4994         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
4995 }
4996
4997 #[test]
4998 fn test_onchain_to_onchain_claim() {
4999         // Test that in case of channel closure, we detect the state of output and claim HTLC
5000         // on downstream peer's remote commitment tx.
5001         // First, have C claim an HTLC against its own latest commitment transaction.
5002         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5003         // channel.
5004         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5005         // gets broadcast.
5006
5007         let chanmon_cfgs = create_chanmon_cfgs(3);
5008         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5009         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5010         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5011
5012         // Create some initial channels
5013         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5014         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5015
5016         // Rebalance the network a bit by relaying one payment through all the channels ...
5017         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5018         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000);
5019
5020         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5021         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5022         check_spends!(commitment_tx[0], chan_2.3);
5023         nodes[2].node.claim_funds(payment_preimage);
5024         check_added_monitors!(nodes[2], 1);
5025         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5026         assert!(updates.update_add_htlcs.is_empty());
5027         assert!(updates.update_fail_htlcs.is_empty());
5028         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5029         assert!(updates.update_fail_malformed_htlcs.is_empty());
5030
5031         mine_transaction(&nodes[2], &commitment_tx[0]);
5032         check_closed_broadcast!(nodes[2], true);
5033         check_added_monitors!(nodes[2], 1);
5034
5035         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5036         assert_eq!(c_txn.len(), 3);
5037         assert_eq!(c_txn[0], c_txn[2]);
5038         assert_eq!(commitment_tx[0], c_txn[1]);
5039         check_spends!(c_txn[1], chan_2.3);
5040         check_spends!(c_txn[2], c_txn[1]);
5041         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5042         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5043         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5044         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5045
5046         // 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
5047         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5048         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5049         {
5050                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5051                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5052                 assert_eq!(b_txn.len(), 3);
5053                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5054                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5055                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5056                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5057                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5058                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5059                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5060                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5061                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5062                 b_txn.clear();
5063         }
5064         check_added_monitors!(nodes[1], 1);
5065         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5066         assert_eq!(msg_events.len(), 3);
5067         check_added_monitors!(nodes[1], 1);
5068         match msg_events[0] {
5069                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5070                 _ => panic!("Unexpected event"),
5071         }
5072         match msg_events[1] {
5073                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5074                 _ => panic!("Unexpected event"),
5075         }
5076         match msg_events[2] {
5077                 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, .. } } => {
5078                         assert!(update_add_htlcs.is_empty());
5079                         assert!(update_fail_htlcs.is_empty());
5080                         assert_eq!(update_fulfill_htlcs.len(), 1);
5081                         assert!(update_fail_malformed_htlcs.is_empty());
5082                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5083                 },
5084                 _ => panic!("Unexpected event"),
5085         };
5086         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5087         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5088         mine_transaction(&nodes[1], &commitment_tx[0]);
5089         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5090         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5091         assert_eq!(b_txn.len(), 3);
5092         check_spends!(b_txn[1], chan_1.3);
5093         check_spends!(b_txn[2], b_txn[1]);
5094         check_spends!(b_txn[0], commitment_tx[0]);
5095         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5096         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5097         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5098
5099         check_closed_broadcast!(nodes[1], true);
5100         check_added_monitors!(nodes[1], 1);
5101 }
5102
5103 #[test]
5104 fn test_duplicate_payment_hash_one_failure_one_success() {
5105         // Topology : A --> B --> C --> D
5106         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5107         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5108         // we forward one of the payments onwards to D.
5109         let chanmon_cfgs = create_chanmon_cfgs(4);
5110         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5111         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5112         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5113
5114         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5115         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5116         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5117
5118         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5119
5120         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5121         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5122                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
5123         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5124
5125         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5126         assert_eq!(commitment_txn[0].input.len(), 1);
5127         check_spends!(commitment_txn[0], chan_2.3);
5128
5129         mine_transaction(&nodes[1], &commitment_txn[0]);
5130         check_closed_broadcast!(nodes[1], true);
5131         check_added_monitors!(nodes[1], 1);
5132
5133         let htlc_timeout_tx;
5134         { // Extract one of the two HTLC-Timeout transaction
5135                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5136                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5137                 assert_eq!(node_txn.len(), 5);
5138                 check_spends!(node_txn[0], commitment_txn[0]);
5139                 assert_eq!(node_txn[0].input.len(), 1);
5140                 check_spends!(node_txn[1], commitment_txn[0]);
5141                 assert_eq!(node_txn[1].input.len(), 1);
5142                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5143                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5144                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5145                 check_spends!(node_txn[2], chan_2.3);
5146                 check_spends!(node_txn[3], node_txn[2]);
5147                 check_spends!(node_txn[4], node_txn[2]);
5148                 htlc_timeout_tx = node_txn[1].clone();
5149         }
5150
5151         nodes[2].node.claim_funds(our_payment_preimage);
5152         mine_transaction(&nodes[2], &commitment_txn[0]);
5153         check_added_monitors!(nodes[2], 2);
5154         let events = nodes[2].node.get_and_clear_pending_msg_events();
5155         match events[0] {
5156                 MessageSendEvent::UpdateHTLCs { .. } => {},
5157                 _ => panic!("Unexpected event"),
5158         }
5159         match events[1] {
5160                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5161                 _ => panic!("Unexepected event"),
5162         }
5163         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5164         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)
5165         check_spends!(htlc_success_txn[2], chan_2.3);
5166         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5167         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5168         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5169         assert_eq!(htlc_success_txn[0].input.len(), 1);
5170         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5171         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5172         assert_eq!(htlc_success_txn[1].input.len(), 1);
5173         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5174         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5175         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5176         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5177
5178         mine_transaction(&nodes[1], &htlc_timeout_tx);
5179         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5180         expect_pending_htlcs_forwardable!(nodes[1]);
5181         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5182         assert!(htlc_updates.update_add_htlcs.is_empty());
5183         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5184         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5185         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5186         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5187         check_added_monitors!(nodes[1], 1);
5188
5189         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5190         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5191         {
5192                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5193                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5194                 assert_eq!(events.len(), 1);
5195                 match events[0] {
5196                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5197                         },
5198                         _ => { panic!("Unexpected event"); }
5199                 }
5200         }
5201         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5202
5203         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5204         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5205         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5206         assert!(updates.update_add_htlcs.is_empty());
5207         assert!(updates.update_fail_htlcs.is_empty());
5208         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5209         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5210         assert!(updates.update_fail_malformed_htlcs.is_empty());
5211         check_added_monitors!(nodes[1], 1);
5212
5213         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5214         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5215
5216         let events = nodes[0].node.get_and_clear_pending_events();
5217         match events[0] {
5218                 Event::PaymentSent { ref payment_preimage } => {
5219                         assert_eq!(*payment_preimage, our_payment_preimage);
5220                 }
5221                 _ => panic!("Unexpected event"),
5222         }
5223 }
5224
5225 #[test]
5226 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5227         let chanmon_cfgs = create_chanmon_cfgs(2);
5228         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5229         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5230         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5231
5232         // Create some initial channels
5233         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5234
5235         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5236         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5237         assert_eq!(local_txn.len(), 1);
5238         assert_eq!(local_txn[0].input.len(), 1);
5239         check_spends!(local_txn[0], chan_1.3);
5240
5241         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5242         nodes[1].node.claim_funds(payment_preimage);
5243         check_added_monitors!(nodes[1], 1);
5244         mine_transaction(&nodes[1], &local_txn[0]);
5245         check_added_monitors!(nodes[1], 1);
5246         let events = nodes[1].node.get_and_clear_pending_msg_events();
5247         match events[0] {
5248                 MessageSendEvent::UpdateHTLCs { .. } => {},
5249                 _ => panic!("Unexpected event"),
5250         }
5251         match events[1] {
5252                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5253                 _ => panic!("Unexepected event"),
5254         }
5255         let node_tx = {
5256                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5257                 assert_eq!(node_txn.len(), 3);
5258                 assert_eq!(node_txn[0], node_txn[2]);
5259                 assert_eq!(node_txn[1], local_txn[0]);
5260                 assert_eq!(node_txn[0].input.len(), 1);
5261                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5262                 check_spends!(node_txn[0], local_txn[0]);
5263                 node_txn[0].clone()
5264         };
5265
5266         mine_transaction(&nodes[1], &node_tx);
5267         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5268
5269         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5270         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5271         assert_eq!(spend_txn.len(), 1);
5272         check_spends!(spend_txn[0], node_tx);
5273 }
5274
5275 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5276         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5277         // unrevoked commitment transaction.
5278         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5279         // a remote RAA before they could be failed backwards (and combinations thereof).
5280         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5281         // use the same payment hashes.
5282         // Thus, we use a six-node network:
5283         //
5284         // A \         / E
5285         //    - C - D -
5286         // B /         \ F
5287         // And test where C fails back to A/B when D announces its latest commitment transaction
5288         let chanmon_cfgs = create_chanmon_cfgs(6);
5289         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5290         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5291         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5292         let logger = test_utils::TestLogger::new();
5293
5294         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5295         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5296         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5297         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5298         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5299
5300         // Rebalance and check output sanity...
5301         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000);
5302         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000);
5303         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5304
5305         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5306         // 0th HTLC:
5307         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
5308         // 1st HTLC:
5309         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
5310         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5311         let our_node_id = &nodes[1].node.get_our_node_id();
5312         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5313         // 2nd HTLC:
5314         send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_1, nodes[5].node.create_inbound_payment_for_hash(payment_hash_1, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5315         // 3rd HTLC:
5316         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_2, nodes[5].node.create_inbound_payment_for_hash(payment_hash_2, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5317         // 4th HTLC:
5318         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5319         // 5th HTLC:
5320         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5321         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5322         // 6th HTLC:
5323         send_along_route_with_secret(&nodes[1], route.clone(), &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_3, nodes[5].node.create_inbound_payment_for_hash(payment_hash_3, None, 7200, 0).unwrap());
5324         // 7th HTLC:
5325         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_4, nodes[5].node.create_inbound_payment_for_hash(payment_hash_4, None, 7200, 0).unwrap());
5326
5327         // 8th HTLC:
5328         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5329         // 9th HTLC:
5330         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5331         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], ds_dust_limit*1000, payment_hash_5, nodes[5].node.create_inbound_payment_for_hash(payment_hash_5, None, 7200, 0).unwrap()); // not added < dust limit + HTLC tx fee
5332
5333         // 10th HTLC:
5334         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
5335         // 11th HTLC:
5336         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5337         send_along_route_with_secret(&nodes[1], route, &[&[&nodes[2], &nodes[3], &nodes[5]]], 1000000, payment_hash_6, nodes[5].node.create_inbound_payment_for_hash(payment_hash_6, None, 7200, 0).unwrap());
5338
5339         // Double-check that six of the new HTLC were added
5340         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5341         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5342         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5343         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5344
5345         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5346         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5347         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
5348         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
5349         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
5350         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
5351         check_added_monitors!(nodes[4], 0);
5352         expect_pending_htlcs_forwardable!(nodes[4]);
5353         check_added_monitors!(nodes[4], 1);
5354
5355         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5356         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5357         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5358         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5359         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5360         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5361
5362         // Fail 3rd below-dust and 7th above-dust HTLCs
5363         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
5364         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
5365         check_added_monitors!(nodes[5], 0);
5366         expect_pending_htlcs_forwardable!(nodes[5]);
5367         check_added_monitors!(nodes[5], 1);
5368
5369         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5370         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5371         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5372         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5373
5374         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5375
5376         expect_pending_htlcs_forwardable!(nodes[3]);
5377         check_added_monitors!(nodes[3], 1);
5378         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5379         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5380         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5381         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5382         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5383         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5384         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5385         if deliver_last_raa {
5386                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5387         } else {
5388                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5389         }
5390
5391         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5392         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5393         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5394         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5395         //
5396         // We now broadcast the latest commitment transaction, which *should* result in failures for
5397         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5398         // the non-broadcast above-dust HTLCs.
5399         //
5400         // Alternatively, we may broadcast the previous commitment transaction, which should only
5401         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5402         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5403
5404         if announce_latest {
5405                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5406         } else {
5407                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5408         }
5409         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5410         check_closed_broadcast!(nodes[2], true);
5411         expect_pending_htlcs_forwardable!(nodes[2]);
5412         check_added_monitors!(nodes[2], 3);
5413
5414         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5415         assert_eq!(cs_msgs.len(), 2);
5416         let mut a_done = false;
5417         for msg in cs_msgs {
5418                 match msg {
5419                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5420                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5421                                 // should be failed-backwards here.
5422                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5423                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5424                                         for htlc in &updates.update_fail_htlcs {
5425                                                 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 });
5426                                         }
5427                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5428                                         assert!(!a_done);
5429                                         a_done = true;
5430                                         &nodes[0]
5431                                 } else {
5432                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5433                                         for htlc in &updates.update_fail_htlcs {
5434                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5435                                         }
5436                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5437                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5438                                         &nodes[1]
5439                                 };
5440                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5441                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5442                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5443                                 if announce_latest {
5444                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5445                                         if *node_id == nodes[0].node.get_our_node_id() {
5446                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5447                                         }
5448                                 }
5449                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5450                         },
5451                         _ => panic!("Unexpected event"),
5452                 }
5453         }
5454
5455         let as_events = nodes[0].node.get_and_clear_pending_events();
5456         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5457         let mut as_failds = HashSet::new();
5458         for event in as_events.iter() {
5459                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5460                         assert!(as_failds.insert(*payment_hash));
5461                         if *payment_hash != payment_hash_2 {
5462                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5463                         } else {
5464                                 assert!(!rejected_by_dest);
5465                         }
5466                 } else { panic!("Unexpected event"); }
5467         }
5468         assert!(as_failds.contains(&payment_hash_1));
5469         assert!(as_failds.contains(&payment_hash_2));
5470         if announce_latest {
5471                 assert!(as_failds.contains(&payment_hash_3));
5472                 assert!(as_failds.contains(&payment_hash_5));
5473         }
5474         assert!(as_failds.contains(&payment_hash_6));
5475
5476         let bs_events = nodes[1].node.get_and_clear_pending_events();
5477         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5478         let mut bs_failds = HashSet::new();
5479         for event in bs_events.iter() {
5480                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5481                         assert!(bs_failds.insert(*payment_hash));
5482                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5483                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5484                         } else {
5485                                 assert!(!rejected_by_dest);
5486                         }
5487                 } else { panic!("Unexpected event"); }
5488         }
5489         assert!(bs_failds.contains(&payment_hash_1));
5490         assert!(bs_failds.contains(&payment_hash_2));
5491         if announce_latest {
5492                 assert!(bs_failds.contains(&payment_hash_4));
5493         }
5494         assert!(bs_failds.contains(&payment_hash_5));
5495
5496         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5497         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5498         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5499         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5500         // PaymentFailureNetworkUpdates.
5501         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5502         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5503         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5504         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5505         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5506                 match event {
5507                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5508                         _ => panic!("Unexpected event"),
5509                 }
5510         }
5511 }
5512
5513 #[test]
5514 fn test_fail_backwards_latest_remote_announce_a() {
5515         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5516 }
5517
5518 #[test]
5519 fn test_fail_backwards_latest_remote_announce_b() {
5520         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5521 }
5522
5523 #[test]
5524 fn test_fail_backwards_previous_remote_announce() {
5525         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5526         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5527         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5528 }
5529
5530 #[test]
5531 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5532         let chanmon_cfgs = create_chanmon_cfgs(2);
5533         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5534         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5535         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5536
5537         // Create some initial channels
5538         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5539
5540         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5541         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5542         assert_eq!(local_txn[0].input.len(), 1);
5543         check_spends!(local_txn[0], chan_1.3);
5544
5545         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5546         mine_transaction(&nodes[0], &local_txn[0]);
5547         check_closed_broadcast!(nodes[0], true);
5548         check_added_monitors!(nodes[0], 1);
5549
5550         let htlc_timeout = {
5551                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5552                 assert_eq!(node_txn[0].input.len(), 1);
5553                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5554                 check_spends!(node_txn[0], local_txn[0]);
5555                 node_txn[0].clone()
5556         };
5557
5558         mine_transaction(&nodes[0], &htlc_timeout);
5559         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5560         expect_payment_failed!(nodes[0], our_payment_hash, true);
5561
5562         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5563         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5564         assert_eq!(spend_txn.len(), 3);
5565         check_spends!(spend_txn[0], local_txn[0]);
5566         check_spends!(spend_txn[1], htlc_timeout);
5567         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5568 }
5569
5570 #[test]
5571 fn test_key_derivation_params() {
5572         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5573         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5574         // let us re-derive the channel key set to then derive a delayed_payment_key.
5575
5576         let chanmon_cfgs = create_chanmon_cfgs(3);
5577
5578         // We manually create the node configuration to backup the seed.
5579         let seed = [42; 32];
5580         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5581         let chain_monitor = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[0].chain_source), &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator, &chanmon_cfgs[0].persister, &keys_manager);
5582         let node = NodeCfg { chain_source: &chanmon_cfgs[0].chain_source, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, chain_monitor, keys_manager: &keys_manager, node_seed: seed };
5583         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5584         node_cfgs.remove(0);
5585         node_cfgs.insert(0, node);
5586
5587         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5588         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5589
5590         // Create some initial channels
5591         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5592         // for node 0
5593         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5594         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5595         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5596
5597         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5598         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5599         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5600         assert_eq!(local_txn_1[0].input.len(), 1);
5601         check_spends!(local_txn_1[0], chan_1.3);
5602
5603         // We check funding pubkey are unique
5604         let (from_0_funding_key_0, from_0_funding_key_1) = (PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_0[0].input[0].witness[3][36..69]));
5605         let (from_1_funding_key_0, from_1_funding_key_1) = (PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][2..35]), PublicKey::from_slice(&local_txn_1[0].input[0].witness[3][36..69]));
5606         if from_0_funding_key_0 == from_1_funding_key_0
5607             || from_0_funding_key_0 == from_1_funding_key_1
5608             || from_0_funding_key_1 == from_1_funding_key_0
5609             || from_0_funding_key_1 == from_1_funding_key_1 {
5610                 panic!("Funding pubkeys aren't unique");
5611         }
5612
5613         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5614         mine_transaction(&nodes[0], &local_txn_1[0]);
5615         check_closed_broadcast!(nodes[0], true);
5616         check_added_monitors!(nodes[0], 1);
5617
5618         let htlc_timeout = {
5619                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5620                 assert_eq!(node_txn[0].input.len(), 1);
5621                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5622                 check_spends!(node_txn[0], local_txn_1[0]);
5623                 node_txn[0].clone()
5624         };
5625
5626         mine_transaction(&nodes[0], &htlc_timeout);
5627         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5628         expect_payment_failed!(nodes[0], our_payment_hash, true);
5629
5630         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5631         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5632         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5633         assert_eq!(spend_txn.len(), 3);
5634         check_spends!(spend_txn[0], local_txn_1[0]);
5635         check_spends!(spend_txn[1], htlc_timeout);
5636         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5637 }
5638
5639 #[test]
5640 fn test_static_output_closing_tx() {
5641         let chanmon_cfgs = create_chanmon_cfgs(2);
5642         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5643         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5644         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5645
5646         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5647
5648         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5649         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5650
5651         mine_transaction(&nodes[0], &closing_tx);
5652         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5653
5654         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5655         assert_eq!(spend_txn.len(), 1);
5656         check_spends!(spend_txn[0], closing_tx);
5657
5658         mine_transaction(&nodes[1], &closing_tx);
5659         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5660
5661         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5662         assert_eq!(spend_txn.len(), 1);
5663         check_spends!(spend_txn[0], closing_tx);
5664 }
5665
5666 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
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         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5672
5673         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5674
5675         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5676         // present in B's local commitment transaction, but none of A's commitment transactions.
5677         assert!(nodes[1].node.claim_funds(our_payment_preimage));
5678         check_added_monitors!(nodes[1], 1);
5679
5680         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5681         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5682         let events = nodes[0].node.get_and_clear_pending_events();
5683         assert_eq!(events.len(), 1);
5684         match events[0] {
5685                 Event::PaymentSent { payment_preimage } => {
5686                         assert_eq!(payment_preimage, our_payment_preimage);
5687                 },
5688                 _ => panic!("Unexpected event"),
5689         }
5690
5691         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5692         check_added_monitors!(nodes[0], 1);
5693         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5694         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5695         check_added_monitors!(nodes[1], 1);
5696
5697         let starting_block = nodes[1].best_block_info();
5698         let mut block = Block {
5699                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5700                 txdata: vec![],
5701         };
5702         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5703                 connect_block(&nodes[1], &block);
5704                 block.header.prev_blockhash = block.block_hash();
5705         }
5706         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5707         check_closed_broadcast!(nodes[1], true);
5708         check_added_monitors!(nodes[1], 1);
5709 }
5710
5711 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5712         let chanmon_cfgs = create_chanmon_cfgs(2);
5713         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5714         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5715         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5716         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5717         let logger = test_utils::TestLogger::new();
5718
5719         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5720         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5721         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5722         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5723         check_added_monitors!(nodes[0], 1);
5724
5725         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5726
5727         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5728         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5729         // to "time out" the HTLC.
5730
5731         let starting_block = nodes[1].best_block_info();
5732         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5733
5734         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5735                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5736                 header.prev_blockhash = header.block_hash();
5737         }
5738         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5739         check_closed_broadcast!(nodes[0], true);
5740         check_added_monitors!(nodes[0], 1);
5741 }
5742
5743 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5744         let chanmon_cfgs = create_chanmon_cfgs(3);
5745         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5746         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5747         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5748         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5749
5750         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5751         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5752         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5753         // actually revoked.
5754         let htlc_value = if use_dust { 50000 } else { 3000000 };
5755         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5756         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5757         expect_pending_htlcs_forwardable!(nodes[1]);
5758         check_added_monitors!(nodes[1], 1);
5759
5760         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5761         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5762         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5763         check_added_monitors!(nodes[0], 1);
5764         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5765         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5766         check_added_monitors!(nodes[1], 1);
5767         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5768         check_added_monitors!(nodes[1], 1);
5769         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5770
5771         if check_revoke_no_close {
5772                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5773                 check_added_monitors!(nodes[0], 1);
5774         }
5775
5776         let starting_block = nodes[1].best_block_info();
5777         let mut block = Block {
5778                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5779                 txdata: vec![],
5780         };
5781         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5782                 connect_block(&nodes[0], &block);
5783                 block.header.prev_blockhash = block.block_hash();
5784         }
5785         if !check_revoke_no_close {
5786                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5787                 check_closed_broadcast!(nodes[0], true);
5788                 check_added_monitors!(nodes[0], 1);
5789         } else {
5790                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5791         }
5792 }
5793
5794 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5795 // There are only a few cases to test here:
5796 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5797 //    broadcastable commitment transactions result in channel closure,
5798 //  * its included in an unrevoked-but-previous remote commitment transaction,
5799 //  * its included in the latest remote or local commitment transactions.
5800 // We test each of the three possible commitment transactions individually and use both dust and
5801 // non-dust HTLCs.
5802 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5803 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5804 // tested for at least one of the cases in other tests.
5805 #[test]
5806 fn htlc_claim_single_commitment_only_a() {
5807         do_htlc_claim_local_commitment_only(true);
5808         do_htlc_claim_local_commitment_only(false);
5809
5810         do_htlc_claim_current_remote_commitment_only(true);
5811         do_htlc_claim_current_remote_commitment_only(false);
5812 }
5813
5814 #[test]
5815 fn htlc_claim_single_commitment_only_b() {
5816         do_htlc_claim_previous_remote_commitment_only(true, false);
5817         do_htlc_claim_previous_remote_commitment_only(false, false);
5818         do_htlc_claim_previous_remote_commitment_only(true, true);
5819         do_htlc_claim_previous_remote_commitment_only(false, true);
5820 }
5821
5822 #[test]
5823 #[should_panic]
5824 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5825         let chanmon_cfgs = create_chanmon_cfgs(2);
5826         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5827         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5828         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5829         //Force duplicate channel ids
5830         for node in nodes.iter() {
5831                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5832         }
5833
5834         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5835         let channel_value_satoshis=10000;
5836         let push_msat=10001;
5837         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5838         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5839         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5840
5841         //Create a second channel with a channel_id collision
5842         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5843 }
5844
5845 #[test]
5846 fn bolt2_open_channel_sending_node_checks_part2() {
5847         let chanmon_cfgs = create_chanmon_cfgs(2);
5848         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5849         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5850         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5851
5852         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5853         let channel_value_satoshis=2^24;
5854         let push_msat=10001;
5855         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5856
5857         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5858         let channel_value_satoshis=10000;
5859         // Test when push_msat is equal to 1000 * funding_satoshis.
5860         let push_msat=1000*channel_value_satoshis+1;
5861         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5862
5863         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5864         let channel_value_satoshis=10000;
5865         let push_msat=10001;
5866         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
5867         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5868         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5869
5870         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5871         // 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
5872         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5873
5874         // 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.
5875         assert!(BREAKDOWN_TIMEOUT>0);
5876         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5877
5878         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5879         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5880         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5881
5882         // 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.
5883         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5884         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5885         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5886         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5887         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5888 }
5889
5890 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5891 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5892 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5893 // is no longer affordable once it's freed.
5894 #[test]
5895 fn test_fail_holding_cell_htlc_upon_free() {
5896         let chanmon_cfgs = create_chanmon_cfgs(2);
5897         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5898         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5899         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5900         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5901         let logger = test_utils::TestLogger::new();
5902
5903         // First nodes[0] generates an update_fee, setting the channel's
5904         // pending_update_fee.
5905         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
5906         check_added_monitors!(nodes[0], 1);
5907
5908         let events = nodes[0].node.get_and_clear_pending_msg_events();
5909         assert_eq!(events.len(), 1);
5910         let (update_msg, commitment_signed) = match events[0] {
5911                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5912                         (update_fee.as_ref(), commitment_signed)
5913                 },
5914                 _ => panic!("Unexpected event"),
5915         };
5916
5917         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5918
5919         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5920         let channel_reserve = chan_stat.channel_reserve_msat;
5921         let feerate = get_feerate!(nodes[0], chan.2);
5922
5923         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5924         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
5925         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
5926         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5927         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
5928
5929         // Send a payment which passes reserve checks but gets stuck in the holding cell.
5930         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
5931         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5932         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5933
5934         // Flush the pending fee update.
5935         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5936         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5937         check_added_monitors!(nodes[1], 1);
5938         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
5939         check_added_monitors!(nodes[0], 1);
5940
5941         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
5942         // HTLC, but now that the fee has been raised the payment will now fail, causing
5943         // us to surface its failure to the user.
5944         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5945         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5946         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
5947         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", log_bytes!(our_payment_hash.0), chan_stat.channel_reserve_msat);
5948         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5949
5950         // Check that the payment failed to be sent out.
5951         let events = nodes[0].node.get_and_clear_pending_events();
5952         assert_eq!(events.len(), 1);
5953         match &events[0] {
5954                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
5955                         assert_eq!(our_payment_hash.clone(), *payment_hash);
5956                         assert_eq!(*rejected_by_dest, false);
5957                         assert_eq!(*error_code, None);
5958                         assert_eq!(*error_data, None);
5959                 },
5960                 _ => panic!("Unexpected event"),
5961         }
5962 }
5963
5964 // Test that if multiple HTLCs are released from the holding cell and one is
5965 // valid but the other is no longer valid upon release, the valid HTLC can be
5966 // successfully completed while the other one fails as expected.
5967 #[test]
5968 fn test_free_and_fail_holding_cell_htlcs() {
5969         let chanmon_cfgs = create_chanmon_cfgs(2);
5970         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5971         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5972         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5973         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5974         let logger = test_utils::TestLogger::new();
5975
5976         // First nodes[0] generates an update_fee, setting the channel's
5977         // pending_update_fee.
5978         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
5979         check_added_monitors!(nodes[0], 1);
5980
5981         let events = nodes[0].node.get_and_clear_pending_msg_events();
5982         assert_eq!(events.len(), 1);
5983         let (update_msg, commitment_signed) = match events[0] {
5984                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5985                         (update_fee.as_ref(), commitment_signed)
5986                 },
5987                 _ => panic!("Unexpected event"),
5988         };
5989
5990         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5991
5992         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5993         let channel_reserve = chan_stat.channel_reserve_msat;
5994         let feerate = get_feerate!(nodes[0], chan.2);
5995
5996         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5997         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
5998         let amt_1 = 20000;
5999         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
6000         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6001         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6002         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6003         let route_2 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6004
6005         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6006         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6007         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6008         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6009         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6010         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6011         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6012
6013         // Flush the pending fee update.
6014         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6015         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6016         check_added_monitors!(nodes[1], 1);
6017         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6018         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6019         check_added_monitors!(nodes[0], 2);
6020
6021         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6022         // but now that the fee has been raised the second payment will now fail, causing us
6023         // to surface its failure to the user. The first payment should succeed.
6024         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6025         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6026         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6027         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", log_bytes!(payment_hash_2.0), chan_stat.channel_reserve_msat);
6028         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6029
6030         // Check that the second payment failed to be sent out.
6031         let events = nodes[0].node.get_and_clear_pending_events();
6032         assert_eq!(events.len(), 1);
6033         match &events[0] {
6034                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6035                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6036                         assert_eq!(*rejected_by_dest, false);
6037                         assert_eq!(*error_code, None);
6038                         assert_eq!(*error_data, None);
6039                 },
6040                 _ => panic!("Unexpected event"),
6041         }
6042
6043         // Complete the first payment and the RAA from the fee update.
6044         let (payment_event, send_raa_event) = {
6045                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6046                 assert_eq!(msgs.len(), 2);
6047                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6048         };
6049         let raa = match send_raa_event {
6050                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6051                 _ => panic!("Unexpected event"),
6052         };
6053         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6054         check_added_monitors!(nodes[1], 1);
6055         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6056         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6057         let events = nodes[1].node.get_and_clear_pending_events();
6058         assert_eq!(events.len(), 1);
6059         match events[0] {
6060                 Event::PendingHTLCsForwardable { .. } => {},
6061                 _ => panic!("Unexpected event"),
6062         }
6063         nodes[1].node.process_pending_htlc_forwards();
6064         let events = nodes[1].node.get_and_clear_pending_events();
6065         assert_eq!(events.len(), 1);
6066         match events[0] {
6067                 Event::PaymentReceived { .. } => {},
6068                 _ => panic!("Unexpected event"),
6069         }
6070         nodes[1].node.claim_funds(payment_preimage_1);
6071         check_added_monitors!(nodes[1], 1);
6072         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6073         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6074         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6075         let events = nodes[0].node.get_and_clear_pending_events();
6076         assert_eq!(events.len(), 1);
6077         match events[0] {
6078                 Event::PaymentSent { ref payment_preimage } => {
6079                         assert_eq!(*payment_preimage, payment_preimage_1);
6080                 }
6081                 _ => panic!("Unexpected event"),
6082         }
6083 }
6084
6085 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6086 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6087 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6088 // once it's freed.
6089 #[test]
6090 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6091         let chanmon_cfgs = create_chanmon_cfgs(3);
6092         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6093         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6094         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6095         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6096         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6097         let logger = test_utils::TestLogger::new();
6098
6099         // First nodes[1] generates an update_fee, setting the channel's
6100         // pending_update_fee.
6101         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6102         check_added_monitors!(nodes[1], 1);
6103
6104         let events = nodes[1].node.get_and_clear_pending_msg_events();
6105         assert_eq!(events.len(), 1);
6106         let (update_msg, commitment_signed) = match events[0] {
6107                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6108                         (update_fee.as_ref(), commitment_signed)
6109                 },
6110                 _ => panic!("Unexpected event"),
6111         };
6112
6113         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6114
6115         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6116         let channel_reserve = chan_stat.channel_reserve_msat;
6117         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6118
6119         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6120         let feemsat = 239;
6121         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6122         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6123         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6124         let payment_event = {
6125                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6126                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6127                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6128                 check_added_monitors!(nodes[0], 1);
6129
6130                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6131                 assert_eq!(events.len(), 1);
6132
6133                 SendEvent::from_event(events.remove(0))
6134         };
6135         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6136         check_added_monitors!(nodes[1], 0);
6137         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6138         expect_pending_htlcs_forwardable!(nodes[1]);
6139
6140         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6141         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6142
6143         // Flush the pending fee update.
6144         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6145         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6146         check_added_monitors!(nodes[2], 1);
6147         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6148         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6149         check_added_monitors!(nodes[1], 2);
6150
6151         // A final RAA message is generated to finalize the fee update.
6152         let events = nodes[1].node.get_and_clear_pending_msg_events();
6153         assert_eq!(events.len(), 1);
6154
6155         let raa_msg = match &events[0] {
6156                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6157                         msg.clone()
6158                 },
6159                 _ => panic!("Unexpected event"),
6160         };
6161
6162         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6163         check_added_monitors!(nodes[2], 1);
6164         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6165
6166         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6167         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6168         assert_eq!(process_htlc_forwards_event.len(), 1);
6169         match &process_htlc_forwards_event[0] {
6170                 &Event::PendingHTLCsForwardable { .. } => {},
6171                 _ => panic!("Unexpected event"),
6172         }
6173
6174         // In response, we call ChannelManager's process_pending_htlc_forwards
6175         nodes[1].node.process_pending_htlc_forwards();
6176         check_added_monitors!(nodes[1], 1);
6177
6178         // This causes the HTLC to be failed backwards.
6179         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6180         assert_eq!(fail_event.len(), 1);
6181         let (fail_msg, commitment_signed) = match &fail_event[0] {
6182                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6183                         assert_eq!(updates.update_add_htlcs.len(), 0);
6184                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6185                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6186                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6187                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6188                 },
6189                 _ => panic!("Unexpected event"),
6190         };
6191
6192         // Pass the failure messages back to nodes[0].
6193         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6194         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6195
6196         // Complete the HTLC failure+removal process.
6197         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6198         check_added_monitors!(nodes[0], 1);
6199         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6200         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6201         check_added_monitors!(nodes[1], 2);
6202         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6203         assert_eq!(final_raa_event.len(), 1);
6204         let raa = match &final_raa_event[0] {
6205                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6206                 _ => panic!("Unexpected event"),
6207         };
6208         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6209         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6210         assert_eq!(fail_msg_event.len(), 1);
6211         match &fail_msg_event[0] {
6212                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6213                 _ => panic!("Unexpected event"),
6214         }
6215         let failure_event = nodes[0].node.get_and_clear_pending_events();
6216         assert_eq!(failure_event.len(), 1);
6217         match &failure_event[0] {
6218                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6219                         assert!(!rejected_by_dest);
6220                 },
6221                 _ => panic!("Unexpected event"),
6222         }
6223         check_added_monitors!(nodes[0], 1);
6224 }
6225
6226 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6227 // 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.
6228 //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.
6229
6230 #[test]
6231 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6232         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6233         let chanmon_cfgs = create_chanmon_cfgs(2);
6234         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6235         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6236         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6237         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6238
6239         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6240         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6241         let logger = test_utils::TestLogger::new();
6242         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6243         route.paths[0][0].fee_msat = 100;
6244
6245         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6246                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6247         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6248         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6249 }
6250
6251 #[test]
6252 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6253         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6254         let chanmon_cfgs = create_chanmon_cfgs(2);
6255         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6256         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6257         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6258         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6259         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6260
6261         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6262         let logger = test_utils::TestLogger::new();
6263         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6264         route.paths[0][0].fee_msat = 0;
6265         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6266                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6267
6268         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6269         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6270 }
6271
6272 #[test]
6273 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6274         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6275         let chanmon_cfgs = create_chanmon_cfgs(2);
6276         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6277         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6278         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6279         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6280
6281         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6282         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6283         let logger = test_utils::TestLogger::new();
6284         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6285         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6286         check_added_monitors!(nodes[0], 1);
6287         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6288         updates.update_add_htlcs[0].amount_msat = 0;
6289
6290         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6291         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6292         check_closed_broadcast!(nodes[1], true).unwrap();
6293         check_added_monitors!(nodes[1], 1);
6294 }
6295
6296 #[test]
6297 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6298         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6299         //It is enforced when constructing a route.
6300         let chanmon_cfgs = create_chanmon_cfgs(2);
6301         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6302         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6303         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6304         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6305         let logger = test_utils::TestLogger::new();
6306
6307         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6308
6309         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6310         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000000, 500000001, &logger).unwrap();
6311         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6312                 assert_eq!(err, &"Channel CLTV overflowed?"));
6313 }
6314
6315 #[test]
6316 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6317         //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.
6318         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6319         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6320         let chanmon_cfgs = create_chanmon_cfgs(2);
6321         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6322         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6323         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6324         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6325         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6326
6327         let logger = test_utils::TestLogger::new();
6328         for i in 0..max_accepted_htlcs {
6329                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6330                 let payment_event = {
6331                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6332                         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6333                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6334                         check_added_monitors!(nodes[0], 1);
6335
6336                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6337                         assert_eq!(events.len(), 1);
6338                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6339                                 assert_eq!(htlcs[0].htlc_id, i);
6340                         } else {
6341                                 assert!(false);
6342                         }
6343                         SendEvent::from_event(events.remove(0))
6344                 };
6345                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6346                 check_added_monitors!(nodes[1], 0);
6347                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6348
6349                 expect_pending_htlcs_forwardable!(nodes[1]);
6350                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6351         }
6352         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6353         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6354         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6355         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6356                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6357
6358         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6359         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6360 }
6361
6362 #[test]
6363 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6364         //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.
6365         let chanmon_cfgs = create_chanmon_cfgs(2);
6366         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6367         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6368         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6369         let channel_value = 100000;
6370         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6371         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6372
6373         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight);
6374
6375         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6376         // Manually create a route over our max in flight (which our router normally automatically
6377         // limits us to.
6378         let route = Route { paths: vec![vec![RouteHop {
6379            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6380            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6381            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6382         }]] };
6383         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6384                 assert!(regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap().is_match(err)));
6385
6386         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6387         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
6388
6389         send_payment(&nodes[0], &[&nodes[1]], max_in_flight);
6390 }
6391
6392 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6393 #[test]
6394 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6395         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6396         let chanmon_cfgs = create_chanmon_cfgs(2);
6397         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6398         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6399         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6400         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6401         let htlc_minimum_msat: u64;
6402         {
6403                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6404                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6405                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6406         }
6407
6408         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6409         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6410         let logger = test_utils::TestLogger::new();
6411         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6412         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6413         check_added_monitors!(nodes[0], 1);
6414         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6415         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6416         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6417         assert!(nodes[1].node.list_channels().is_empty());
6418         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6419         assert!(regex::Regex::new(r"Remote side tried to send less than our minimum HTLC value\. Lower limit: \(\d+\)\. Actual: \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6420         check_added_monitors!(nodes[1], 1);
6421 }
6422
6423 #[test]
6424 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6425         //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
6426         let chanmon_cfgs = create_chanmon_cfgs(2);
6427         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6428         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6429         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6430         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6431         let logger = test_utils::TestLogger::new();
6432
6433         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6434         let channel_reserve = chan_stat.channel_reserve_msat;
6435         let feerate = get_feerate!(nodes[0], chan.2);
6436         // The 2* and +1 are for the fee spike reserve.
6437         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6438
6439         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6440         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6441         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6442         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6443         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6444         check_added_monitors!(nodes[0], 1);
6445         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6446
6447         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6448         // at this time channel-initiatee receivers are not required to enforce that senders
6449         // respect the fee_spike_reserve.
6450         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6451         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6452
6453         assert!(nodes[1].node.list_channels().is_empty());
6454         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6455         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6456         check_added_monitors!(nodes[1], 1);
6457 }
6458
6459 #[test]
6460 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6461         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6462         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6463         let chanmon_cfgs = create_chanmon_cfgs(2);
6464         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6465         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6466         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6467         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6468         let logger = test_utils::TestLogger::new();
6469
6470         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6471         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6472
6473         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6474         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
6475
6476         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6477         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6478         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6479         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6480
6481         let mut msg = msgs::UpdateAddHTLC {
6482                 channel_id: chan.2,
6483                 htlc_id: 0,
6484                 amount_msat: 1000,
6485                 payment_hash: our_payment_hash,
6486                 cltv_expiry: htlc_cltv,
6487                 onion_routing_packet: onion_packet.clone(),
6488         };
6489
6490         for i in 0..super::channel::OUR_MAX_HTLCS {
6491                 msg.htlc_id = i as u64;
6492                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6493         }
6494         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6495         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6496
6497         assert!(nodes[1].node.list_channels().is_empty());
6498         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6499         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6500         check_added_monitors!(nodes[1], 1);
6501 }
6502
6503 #[test]
6504 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6505         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6506         let chanmon_cfgs = create_chanmon_cfgs(2);
6507         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6508         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6509         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6510         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6511         let logger = test_utils::TestLogger::new();
6512
6513         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6514         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6515         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6516         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6517         check_added_monitors!(nodes[0], 1);
6518         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6519         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6520         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6521
6522         assert!(nodes[1].node.list_channels().is_empty());
6523         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6524         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6525         check_added_monitors!(nodes[1], 1);
6526 }
6527
6528 #[test]
6529 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6530         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6531         let chanmon_cfgs = create_chanmon_cfgs(2);
6532         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6533         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6534         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6535         let logger = test_utils::TestLogger::new();
6536
6537         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6538         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6539         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6540         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6541         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6542         check_added_monitors!(nodes[0], 1);
6543         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6544         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6545         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6546
6547         assert!(nodes[1].node.list_channels().is_empty());
6548         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6549         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6550         check_added_monitors!(nodes[1], 1);
6551 }
6552
6553 #[test]
6554 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6555         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6556         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6557         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6558         let chanmon_cfgs = create_chanmon_cfgs(2);
6559         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6560         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6561         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6562         let logger = test_utils::TestLogger::new();
6563
6564         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6565         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6566         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6567         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6568         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6569         check_added_monitors!(nodes[0], 1);
6570         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6571         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6572
6573         //Disconnect and Reconnect
6574         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6575         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6576         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6577         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6578         assert_eq!(reestablish_1.len(), 1);
6579         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6580         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6581         assert_eq!(reestablish_2.len(), 1);
6582         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6583         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6584         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6585         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6586
6587         //Resend HTLC
6588         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6589         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6590         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6591         check_added_monitors!(nodes[1], 1);
6592         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6593
6594         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6595
6596         assert!(nodes[1].node.list_channels().is_empty());
6597         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6598         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6599         check_added_monitors!(nodes[1], 1);
6600 }
6601
6602 #[test]
6603 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6604         //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.
6605
6606         let chanmon_cfgs = create_chanmon_cfgs(2);
6607         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6608         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6609         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6610         let logger = test_utils::TestLogger::new();
6611         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6612         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6613         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6614         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6615         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6616
6617         check_added_monitors!(nodes[0], 1);
6618         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6619         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6620
6621         let update_msg = msgs::UpdateFulfillHTLC{
6622                 channel_id: chan.2,
6623                 htlc_id: 0,
6624                 payment_preimage: our_payment_preimage,
6625         };
6626
6627         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6628
6629         assert!(nodes[0].node.list_channels().is_empty());
6630         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6631         assert!(regex::Regex::new(r"Remote tried to fulfill/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
6632         check_added_monitors!(nodes[0], 1);
6633 }
6634
6635 #[test]
6636 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6637         //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.
6638
6639         let chanmon_cfgs = create_chanmon_cfgs(2);
6640         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6641         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6642         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6643         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6644         let logger = test_utils::TestLogger::new();
6645
6646         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6647         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6648         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6649         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6650         check_added_monitors!(nodes[0], 1);
6651         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6652         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6653
6654         let update_msg = msgs::UpdateFailHTLC{
6655                 channel_id: chan.2,
6656                 htlc_id: 0,
6657                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6658         };
6659
6660         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6661
6662         assert!(nodes[0].node.list_channels().is_empty());
6663         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6664         assert!(regex::Regex::new(r"Remote tried to fulfill/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
6665         check_added_monitors!(nodes[0], 1);
6666 }
6667
6668 #[test]
6669 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6670         //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.
6671
6672         let chanmon_cfgs = create_chanmon_cfgs(2);
6673         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6674         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6675         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6676         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6677         let logger = test_utils::TestLogger::new();
6678
6679         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6680         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6681         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6682         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6683         check_added_monitors!(nodes[0], 1);
6684         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6685         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6686         let update_msg = msgs::UpdateFailMalformedHTLC{
6687                 channel_id: chan.2,
6688                 htlc_id: 0,
6689                 sha256_of_onion: [1; 32],
6690                 failure_code: 0x8000,
6691         };
6692
6693         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6694
6695         assert!(nodes[0].node.list_channels().is_empty());
6696         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6697         assert!(regex::Regex::new(r"Remote tried to fulfill/fail HTLC \(\d+\) before it had been committed").unwrap().is_match(err_msg.data.as_str()));
6698         check_added_monitors!(nodes[0], 1);
6699 }
6700
6701 #[test]
6702 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6703         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6704
6705         let chanmon_cfgs = create_chanmon_cfgs(2);
6706         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6707         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6708         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6709         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6710
6711         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6712
6713         nodes[1].node.claim_funds(our_payment_preimage);
6714         check_added_monitors!(nodes[1], 1);
6715
6716         let events = nodes[1].node.get_and_clear_pending_msg_events();
6717         assert_eq!(events.len(), 1);
6718         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6719                 match events[0] {
6720                         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, .. } } => {
6721                                 assert!(update_add_htlcs.is_empty());
6722                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6723                                 assert!(update_fail_htlcs.is_empty());
6724                                 assert!(update_fail_malformed_htlcs.is_empty());
6725                                 assert!(update_fee.is_none());
6726                                 update_fulfill_htlcs[0].clone()
6727                         },
6728                         _ => panic!("Unexpected event"),
6729                 }
6730         };
6731
6732         update_fulfill_msg.htlc_id = 1;
6733
6734         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6735
6736         assert!(nodes[0].node.list_channels().is_empty());
6737         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6738         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6739         check_added_monitors!(nodes[0], 1);
6740 }
6741
6742 #[test]
6743 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6744         //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.
6745
6746         let chanmon_cfgs = create_chanmon_cfgs(2);
6747         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6748         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6749         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6750         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6751
6752         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6753
6754         nodes[1].node.claim_funds(our_payment_preimage);
6755         check_added_monitors!(nodes[1], 1);
6756
6757         let events = nodes[1].node.get_and_clear_pending_msg_events();
6758         assert_eq!(events.len(), 1);
6759         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6760                 match events[0] {
6761                         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, .. } } => {
6762                                 assert!(update_add_htlcs.is_empty());
6763                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6764                                 assert!(update_fail_htlcs.is_empty());
6765                                 assert!(update_fail_malformed_htlcs.is_empty());
6766                                 assert!(update_fee.is_none());
6767                                 update_fulfill_htlcs[0].clone()
6768                         },
6769                         _ => panic!("Unexpected event"),
6770                 }
6771         };
6772
6773         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6774
6775         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6776
6777         assert!(nodes[0].node.list_channels().is_empty());
6778         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6779         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6780         check_added_monitors!(nodes[0], 1);
6781 }
6782
6783 #[test]
6784 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6785         //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.
6786
6787         let chanmon_cfgs = create_chanmon_cfgs(2);
6788         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6789         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6790         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6791         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6792         let logger = test_utils::TestLogger::new();
6793
6794         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6795         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6796         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6797         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6798         check_added_monitors!(nodes[0], 1);
6799
6800         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6801         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6802
6803         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6804         check_added_monitors!(nodes[1], 0);
6805         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6806
6807         let events = nodes[1].node.get_and_clear_pending_msg_events();
6808
6809         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6810                 match events[0] {
6811                         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, .. } } => {
6812                                 assert!(update_add_htlcs.is_empty());
6813                                 assert!(update_fulfill_htlcs.is_empty());
6814                                 assert!(update_fail_htlcs.is_empty());
6815                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6816                                 assert!(update_fee.is_none());
6817                                 update_fail_malformed_htlcs[0].clone()
6818                         },
6819                         _ => panic!("Unexpected event"),
6820                 }
6821         };
6822         update_msg.failure_code &= !0x8000;
6823         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6824
6825         assert!(nodes[0].node.list_channels().is_empty());
6826         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6827         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6828         check_added_monitors!(nodes[0], 1);
6829 }
6830
6831 #[test]
6832 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6833         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6834         //    * 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.
6835
6836         let chanmon_cfgs = create_chanmon_cfgs(3);
6837         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6838         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6839         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6840         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6841         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6842         let logger = test_utils::TestLogger::new();
6843
6844         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6845
6846         //First hop
6847         let mut payment_event = {
6848                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6849                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
6850                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6851                 check_added_monitors!(nodes[0], 1);
6852                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6853                 assert_eq!(events.len(), 1);
6854                 SendEvent::from_event(events.remove(0))
6855         };
6856         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6857         check_added_monitors!(nodes[1], 0);
6858         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6859         expect_pending_htlcs_forwardable!(nodes[1]);
6860         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6861         assert_eq!(events_2.len(), 1);
6862         check_added_monitors!(nodes[1], 1);
6863         payment_event = SendEvent::from_event(events_2.remove(0));
6864         assert_eq!(payment_event.msgs.len(), 1);
6865
6866         //Second Hop
6867         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6868         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6869         check_added_monitors!(nodes[2], 0);
6870         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6871
6872         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6873         assert_eq!(events_3.len(), 1);
6874         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6875                 match events_3[0] {
6876                         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 } } => {
6877                                 assert!(update_add_htlcs.is_empty());
6878                                 assert!(update_fulfill_htlcs.is_empty());
6879                                 assert!(update_fail_htlcs.is_empty());
6880                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6881                                 assert!(update_fee.is_none());
6882                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6883                         },
6884                         _ => panic!("Unexpected event"),
6885                 }
6886         };
6887
6888         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6889
6890         check_added_monitors!(nodes[1], 0);
6891         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6892         expect_pending_htlcs_forwardable!(nodes[1]);
6893         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6894         assert_eq!(events_4.len(), 1);
6895
6896         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6897         match events_4[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, .. } } => {
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                 },
6905                 _ => panic!("Unexpected event"),
6906         };
6907
6908         check_added_monitors!(nodes[1], 1);
6909 }
6910
6911 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6912         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6913         // 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
6914         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6915
6916         let mut chanmon_cfgs = create_chanmon_cfgs(2);
6917         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6918         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6919         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6920         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6921         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6922
6923         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6924
6925         // We route 2 dust-HTLCs between A and B
6926         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6927         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6928         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6929
6930         // Cache one local commitment tx as previous
6931         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6932
6933         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6934         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
6935         check_added_monitors!(nodes[1], 0);
6936         expect_pending_htlcs_forwardable!(nodes[1]);
6937         check_added_monitors!(nodes[1], 1);
6938
6939         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6940         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6941         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6942         check_added_monitors!(nodes[0], 1);
6943
6944         // Cache one local commitment tx as lastest
6945         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6946
6947         let events = nodes[0].node.get_and_clear_pending_msg_events();
6948         match events[0] {
6949                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6950                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6951                 },
6952                 _ => panic!("Unexpected event"),
6953         }
6954         match events[1] {
6955                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6956                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6957                 },
6958                 _ => panic!("Unexpected event"),
6959         }
6960
6961         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6962         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6963         if announce_latest {
6964                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
6965         } else {
6966                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
6967         }
6968
6969         check_closed_broadcast!(nodes[0], true);
6970         check_added_monitors!(nodes[0], 1);
6971
6972         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6973         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6974         let events = nodes[0].node.get_and_clear_pending_events();
6975         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6976         assert_eq!(events.len(), 2);
6977         let mut first_failed = false;
6978         for event in events {
6979                 match event {
6980                         Event::PaymentFailed { payment_hash, .. } => {
6981                                 if payment_hash == payment_hash_1 {
6982                                         assert!(!first_failed);
6983                                         first_failed = true;
6984                                 } else {
6985                                         assert_eq!(payment_hash, payment_hash_2);
6986                                 }
6987                         }
6988                         _ => panic!("Unexpected event"),
6989                 }
6990         }
6991 }
6992
6993 #[test]
6994 fn test_failure_delay_dust_htlc_local_commitment() {
6995         do_test_failure_delay_dust_htlc_local_commitment(true);
6996         do_test_failure_delay_dust_htlc_local_commitment(false);
6997 }
6998
6999 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7000         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7001         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7002         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7003         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7004         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7005         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7006
7007         let chanmon_cfgs = create_chanmon_cfgs(3);
7008         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7009         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7010         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7011         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7012
7013         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7014
7015         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7016         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7017
7018         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7019         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7020
7021         // We revoked bs_commitment_tx
7022         if revoked {
7023                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7024                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
7025         }
7026
7027         let mut timeout_tx = Vec::new();
7028         if local {
7029                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7030                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7031                 check_closed_broadcast!(nodes[0], true);
7032                 check_added_monitors!(nodes[0], 1);
7033                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7034                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7035                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7036                 expect_payment_failed!(nodes[0], dust_hash, true);
7037                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7038                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7039                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7040                 mine_transaction(&nodes[0], &timeout_tx[0]);
7041                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7042                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7043         } else {
7044                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7045                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7046                 check_closed_broadcast!(nodes[0], true);
7047                 check_added_monitors!(nodes[0], 1);
7048                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7049                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7050                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7051                 if !revoked {
7052                         expect_payment_failed!(nodes[0], dust_hash, true);
7053                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7054                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7055                         mine_transaction(&nodes[0], &timeout_tx[0]);
7056                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7057                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7058                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7059                 } else {
7060                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7061                         // commitment tx
7062                         let events = nodes[0].node.get_and_clear_pending_events();
7063                         assert_eq!(events.len(), 2);
7064                         let first;
7065                         match events[0] {
7066                                 Event::PaymentFailed { payment_hash, .. } => {
7067                                         if payment_hash == dust_hash { first = true; }
7068                                         else { first = false; }
7069                                 },
7070                                 _ => panic!("Unexpected event"),
7071                         }
7072                         match events[1] {
7073                                 Event::PaymentFailed { payment_hash, .. } => {
7074                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7075                                         else { assert_eq!(payment_hash, dust_hash); }
7076                                 },
7077                                 _ => panic!("Unexpected event"),
7078                         }
7079                 }
7080         }
7081 }
7082
7083 #[test]
7084 fn test_sweep_outbound_htlc_failure_update() {
7085         do_test_sweep_outbound_htlc_failure_update(false, true);
7086         do_test_sweep_outbound_htlc_failure_update(false, false);
7087         do_test_sweep_outbound_htlc_failure_update(true, false);
7088 }
7089
7090 #[test]
7091 fn test_upfront_shutdown_script() {
7092         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7093         // enforce it at shutdown message
7094
7095         let mut config = UserConfig::default();
7096         config.channel_options.announced_channel = true;
7097         config.peer_channel_config_limits.force_announced_channel_preference = false;
7098         config.channel_options.commit_upfront_shutdown_pubkey = false;
7099         let user_cfgs = [None, Some(config), None];
7100         let chanmon_cfgs = create_chanmon_cfgs(3);
7101         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7102         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7103         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7104
7105         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7106         let flags = InitFeatures::known();
7107         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7108         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7109         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7110         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7111         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7112         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7113     assert!(regex::Regex::new(r"Got shutdown request with a scriptpubkey \([A-Fa-f0-9]+\) which did not match their previous scriptpubkey.").unwrap().is_match(check_closed_broadcast!(nodes[2], true).unwrap().data.as_str()));
7114         check_added_monitors!(nodes[2], 1);
7115
7116         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7117         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7118         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7119         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7120         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7121         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7122         let events = nodes[2].node.get_and_clear_pending_msg_events();
7123         assert_eq!(events.len(), 1);
7124         match events[0] {
7125                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7126                 _ => panic!("Unexpected event"),
7127         }
7128
7129         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7130         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7131         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7132         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7133         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7134         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7135         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7136         let events = nodes[1].node.get_and_clear_pending_msg_events();
7137         assert_eq!(events.len(), 1);
7138         match events[0] {
7139                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7140                 _ => panic!("Unexpected event"),
7141         }
7142
7143         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7144         // channel smoothly, opt-out is from channel initiator here
7145         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7146         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7147         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7148         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7149         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7150         let events = nodes[0].node.get_and_clear_pending_msg_events();
7151         assert_eq!(events.len(), 1);
7152         match events[0] {
7153                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7154                 _ => panic!("Unexpected event"),
7155         }
7156
7157         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7158         //// channel smoothly
7159         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7160         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7161         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7162         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7163         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7164         let events = nodes[0].node.get_and_clear_pending_msg_events();
7165         assert_eq!(events.len(), 2);
7166         match events[0] {
7167                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7168                 _ => panic!("Unexpected event"),
7169         }
7170         match events[1] {
7171                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7172                 _ => panic!("Unexpected event"),
7173         }
7174 }
7175
7176 #[test]
7177 fn test_upfront_shutdown_script_unsupport_segwit() {
7178         // We test that channel is closed early
7179         // if a segwit program is passed as upfront shutdown script,
7180         // but the peer does not support segwit.
7181         let chanmon_cfgs = create_chanmon_cfgs(2);
7182         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7183         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7184         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7185
7186         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7187
7188         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7189         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7190                 .push_slice(&[0, 0])
7191                 .into_script());
7192
7193         let features = InitFeatures::known().clear_shutdown_anysegwit();
7194         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7195
7196         let events = nodes[0].node.get_and_clear_pending_msg_events();
7197         assert_eq!(events.len(), 1);
7198         match events[0] {
7199                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7200                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7201                         assert!(regex::Regex::new(r"Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: (\([A-Fa-f0-9]+\))").unwrap().is_match(&*msg.data));
7202                 },
7203                 _ => panic!("Unexpected event"),
7204         }
7205 }
7206
7207 #[test]
7208 fn test_shutdown_script_any_segwit_allowed() {
7209         let mut config = UserConfig::default();
7210         config.channel_options.announced_channel = true;
7211         config.peer_channel_config_limits.force_announced_channel_preference = false;
7212         config.channel_options.commit_upfront_shutdown_pubkey = false;
7213         let user_cfgs = [None, Some(config), None];
7214         let chanmon_cfgs = create_chanmon_cfgs(3);
7215         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7216         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7217         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7218
7219         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7220         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7221         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7222         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7223         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7224                 .push_slice(&[0, 0])
7225                 .into_script();
7226         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7227         let events = nodes[0].node.get_and_clear_pending_msg_events();
7228         assert_eq!(events.len(), 2);
7229         match events[0] {
7230                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7231                 _ => panic!("Unexpected event"),
7232         }
7233         match events[1] {
7234                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7235                 _ => panic!("Unexpected event"),
7236         }
7237 }
7238
7239 #[test]
7240 fn test_shutdown_script_any_segwit_not_allowed() {
7241         let mut config = UserConfig::default();
7242         config.channel_options.announced_channel = true;
7243         config.peer_channel_config_limits.force_announced_channel_preference = false;
7244         config.channel_options.commit_upfront_shutdown_pubkey = false;
7245         let user_cfgs = [None, Some(config), None];
7246         let chanmon_cfgs = create_chanmon_cfgs(3);
7247         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7248         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7249         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7250
7251         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7252         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7253         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7254         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7255         // Make an any segwit version script
7256         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7257                 .push_slice(&[0, 0])
7258                 .into_script();
7259         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7260         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7261         let events = nodes[0].node.get_and_clear_pending_msg_events();
7262         assert_eq!(events.len(), 2);
7263         match events[1] {
7264                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7265                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7266                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7267                 },
7268                 _ => panic!("Unexpected event"),
7269         }
7270         check_added_monitors!(nodes[0], 1);
7271 }
7272
7273 #[test]
7274 fn test_shutdown_script_segwit_but_not_anysegwit() {
7275         let mut config = UserConfig::default();
7276         config.channel_options.announced_channel = true;
7277         config.peer_channel_config_limits.force_announced_channel_preference = false;
7278         config.channel_options.commit_upfront_shutdown_pubkey = false;
7279         let user_cfgs = [None, Some(config), None];
7280         let chanmon_cfgs = create_chanmon_cfgs(3);
7281         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7282         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7283         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7284
7285         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7286         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7287         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7288         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7289         // Make a segwit script that is not a valid as any segwit
7290         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7291                 .push_slice(&[0, 0])
7292                 .into_script();
7293         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7294         let events = nodes[0].node.get_and_clear_pending_msg_events();
7295         assert_eq!(events.len(), 2);
7296         match events[1] {
7297                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7298                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7299                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7300                 },
7301                 _ => panic!("Unexpected event"),
7302         }
7303         check_added_monitors!(nodes[0], 1);
7304 }
7305
7306 #[test]
7307 fn test_user_configurable_csv_delay() {
7308         // We test our channel constructors yield errors when we pass them absurd csv delay
7309
7310         let mut low_our_to_self_config = UserConfig::default();
7311         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7312         let mut high_their_to_self_config = UserConfig::default();
7313         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7314         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7315         let chanmon_cfgs = create_chanmon_cfgs(2);
7316         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7317         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7318         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7319
7320         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7321         if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7322                 match error {
7323                         APIError::APIMisuseError { err } => { assert!(regex::Regex::new(r"Configured with an unreasonable our_to_self_delay \(\d+\) putting user funds at risks").unwrap().is_match(err.as_str())); },
7324                         _ => panic!("Unexpected event"),
7325                 }
7326         } else { assert!(false) }
7327
7328         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7329         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7330         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7331         open_channel.to_self_delay = 200;
7332         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7333                 match error {
7334                         ChannelError::Close(err) => { assert!(regex::Regex::new(r"Configured with an unreasonable our_to_self_delay \(\d+\) putting user funds at risks").unwrap().is_match(err.as_str()));  },
7335                         _ => panic!("Unexpected event"),
7336                 }
7337         } else { assert!(false); }
7338
7339         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7340         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7341         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
7342         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7343         accept_channel.to_self_delay = 200;
7344         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7345         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7346                 match action {
7347                         &ErrorAction::SendErrorMessage { ref msg } => {
7348                                 assert!(regex::Regex::new(r"They wanted our payments to be delayed by a needlessly long period\. Upper limit: \d+\. Actual: \d+").unwrap().is_match(msg.data.as_str()));
7349                         },
7350                         _ => { assert!(false); }
7351                 }
7352         } else { assert!(false); }
7353
7354         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7355         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7356         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7357         open_channel.to_self_delay = 200;
7358         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &nodes[0].keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7359                 match error {
7360                         ChannelError::Close(err) => { assert!(regex::Regex::new(r"They wanted our payments to be delayed by a needlessly long period\. Upper limit: \d+\. Actual: \d+").unwrap().is_match(err.as_str())); },
7361                         _ => panic!("Unexpected event"),
7362                 }
7363         } else { assert!(false); }
7364 }
7365
7366 #[test]
7367 fn test_data_loss_protect() {
7368         // We want to be sure that :
7369         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7370         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7371         // * we close channel in case of detecting other being fallen behind
7372         // * we are able to claim our own outputs thanks to to_remote being static
7373         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7374         let persister;
7375         let logger;
7376         let fee_estimator;
7377         let tx_broadcaster;
7378         let chain_source;
7379         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7380         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7381         // during signing due to revoked tx
7382         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7383         let keys_manager = &chanmon_cfgs[0].keys_manager;
7384         let monitor;
7385         let node_state_0;
7386         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7387         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7388         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7389
7390         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7391
7392         // Cache node A state before any channel update
7393         let previous_node_state = nodes[0].node.encode();
7394         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7395         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7396
7397         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7398         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
7399
7400         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7401         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7402
7403         // Restore node A from previous state
7404         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7405         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7406         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7407         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7408         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7409         persister = test_utils::TestPersister::new();
7410         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7411         node_state_0 = {
7412                 let mut channel_monitors = HashMap::new();
7413                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7414                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7415                         keys_manager: keys_manager,
7416                         fee_estimator: &fee_estimator,
7417                         chain_monitor: &monitor,
7418                         logger: &logger,
7419                         tx_broadcaster: &tx_broadcaster,
7420                         default_config: UserConfig::default(),
7421                         channel_monitors,
7422                 }).unwrap().1
7423         };
7424         nodes[0].node = &node_state_0;
7425         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7426         nodes[0].chain_monitor = &monitor;
7427         nodes[0].chain_source = &chain_source;
7428
7429         check_added_monitors!(nodes[0], 1);
7430
7431         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7432         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7433
7434         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7435
7436         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7437         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7438         check_added_monitors!(nodes[0], 1);
7439
7440         {
7441                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7442                 assert_eq!(node_txn.len(), 0);
7443         }
7444
7445         let mut reestablish_1 = Vec::with_capacity(1);
7446         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7447                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7448                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7449                         reestablish_1.push(msg.clone());
7450                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7451                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7452                         match action {
7453                                 &ErrorAction::SendErrorMessage { ref msg } => {
7454                                         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");
7455                                 },
7456                                 _ => panic!("Unexpected event!"),
7457                         }
7458                 } else {
7459                         panic!("Unexpected event")
7460                 }
7461         }
7462
7463         // Check we close channel detecting A is fallen-behind
7464         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7465         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7466         check_added_monitors!(nodes[1], 1);
7467
7468
7469         // Check A is able to claim to_remote output
7470         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7471         assert_eq!(node_txn.len(), 1);
7472         check_spends!(node_txn[0], chan.3);
7473         assert_eq!(node_txn[0].output.len(), 2);
7474         mine_transaction(&nodes[0], &node_txn[0]);
7475         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7476         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7477         assert_eq!(spend_txn.len(), 1);
7478         check_spends!(spend_txn[0], node_txn[0]);
7479 }
7480
7481 #[test]
7482 fn test_check_htlc_underpaying() {
7483         // Send payment through A -> B but A is maliciously
7484         // sending a probe payment (i.e less than expected value0
7485         // to B, B should refuse payment.
7486
7487         let chanmon_cfgs = create_chanmon_cfgs(2);
7488         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7489         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7490         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7491
7492         // Create some initial channels
7493         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7494
7495         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 10_000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
7496         let (_, our_payment_hash, _) = get_payment_preimage_hash!(nodes[0]);
7497         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(our_payment_hash, Some(100_000), 7200, 0).unwrap();
7498         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
7499         check_added_monitors!(nodes[0], 1);
7500
7501         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7502         assert_eq!(events.len(), 1);
7503         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
7504         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7505         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7506
7507         // Note that we first have to wait a random delay before processing the receipt of the HTLC,
7508         // and then will wait a second random delay before failing the HTLC back:
7509         expect_pending_htlcs_forwardable!(nodes[1]);
7510         expect_pending_htlcs_forwardable!(nodes[1]);
7511
7512         // Node 3 is expecting payment of 100_000 but received 10_000,
7513         // it should fail htlc like we didn't know the preimage.
7514         nodes[1].node.process_pending_htlc_forwards();
7515
7516         let events = nodes[1].node.get_and_clear_pending_msg_events();
7517         assert_eq!(events.len(), 1);
7518         let (update_fail_htlc, commitment_signed) = match events[0] {
7519                 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 } } => {
7520                         assert!(update_add_htlcs.is_empty());
7521                         assert!(update_fulfill_htlcs.is_empty());
7522                         assert_eq!(update_fail_htlcs.len(), 1);
7523                         assert!(update_fail_malformed_htlcs.is_empty());
7524                         assert!(update_fee.is_none());
7525                         (update_fail_htlcs[0].clone(), commitment_signed)
7526                 },
7527                 _ => panic!("Unexpected event"),
7528         };
7529         check_added_monitors!(nodes[1], 1);
7530
7531         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7532         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7533
7534         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7535         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7536         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7537         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7538 }
7539
7540 #[test]
7541 fn test_announce_disable_channels() {
7542         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7543         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7544
7545         let chanmon_cfgs = create_chanmon_cfgs(2);
7546         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7547         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7548         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7549
7550         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7551         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7552         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7553
7554         // Disconnect peers
7555         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7556         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7557
7558         nodes[0].node.timer_tick_occurred(); // dirty -> stagged
7559         nodes[0].node.timer_tick_occurred(); // staged -> fresh
7560         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7561         assert_eq!(msg_events.len(), 3);
7562         for e in msg_events {
7563                 match e {
7564                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7565                                 let short_id = msg.contents.short_channel_id;
7566                                 // Check generated channel_update match list in PendingChannelUpdate
7567                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7568                                         panic!("Generated ChannelUpdate for wrong chan!");
7569                                 }
7570                         },
7571                         _ => panic!("Unexpected event"),
7572                 }
7573         }
7574         // Reconnect peers
7575         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7576         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7577         assert_eq!(reestablish_1.len(), 3);
7578         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7579         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7580         assert_eq!(reestablish_2.len(), 3);
7581
7582         // Reestablish chan_1
7583         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7584         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7585         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7586         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7587         // Reestablish chan_2
7588         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7589         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7590         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7591         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7592         // Reestablish chan_3
7593         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7594         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7595         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7596         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7597
7598         nodes[0].node.timer_tick_occurred();
7599         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7600 }
7601
7602 #[test]
7603 fn test_bump_penalty_txn_on_revoked_commitment() {
7604         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7605         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7606
7607         let chanmon_cfgs = create_chanmon_cfgs(2);
7608         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7609         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7610         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7611
7612         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7613         let logger = test_utils::TestLogger::new();
7614
7615         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7616         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7617         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000, 30, &logger).unwrap();
7618         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7619
7620         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7621         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7622         assert_eq!(revoked_txn[0].output.len(), 4);
7623         assert_eq!(revoked_txn[0].input.len(), 1);
7624         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7625         let revoked_txid = revoked_txn[0].txid();
7626
7627         let mut penalty_sum = 0;
7628         for outp in revoked_txn[0].output.iter() {
7629                 if outp.script_pubkey.is_v0_p2wsh() {
7630                         penalty_sum += outp.value;
7631                 }
7632         }
7633
7634         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7635         let header_114 = connect_blocks(&nodes[1], 14);
7636
7637         // Actually revoke tx by claiming a HTLC
7638         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7639         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7640         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7641         check_added_monitors!(nodes[1], 1);
7642
7643         // One or more justice tx should have been broadcast, check it
7644         let penalty_1;
7645         let feerate_1;
7646         {
7647                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7648                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7649                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7650                 assert_eq!(node_txn[0].output.len(), 1);
7651                 check_spends!(node_txn[0], revoked_txn[0]);
7652                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7653                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7654                 penalty_1 = node_txn[0].txid();
7655                 node_txn.clear();
7656         };
7657
7658         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7659         connect_blocks(&nodes[1], 15);
7660         let mut penalty_2 = penalty_1;
7661         let mut feerate_2 = 0;
7662         {
7663                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7664                 assert_eq!(node_txn.len(), 1);
7665                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7666                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7667                         assert_eq!(node_txn[0].output.len(), 1);
7668                         check_spends!(node_txn[0], revoked_txn[0]);
7669                         penalty_2 = node_txn[0].txid();
7670                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7671                         assert_ne!(penalty_2, penalty_1);
7672                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7673                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7674                         // Verify 25% bump heuristic
7675                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7676                         node_txn.clear();
7677                 }
7678         }
7679         assert_ne!(feerate_2, 0);
7680
7681         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7682         connect_blocks(&nodes[1], 1);
7683         let penalty_3;
7684         let mut feerate_3 = 0;
7685         {
7686                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7687                 assert_eq!(node_txn.len(), 1);
7688                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7689                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7690                         assert_eq!(node_txn[0].output.len(), 1);
7691                         check_spends!(node_txn[0], revoked_txn[0]);
7692                         penalty_3 = node_txn[0].txid();
7693                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7694                         assert_ne!(penalty_3, penalty_2);
7695                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7696                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7697                         // Verify 25% bump heuristic
7698                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7699                         node_txn.clear();
7700                 }
7701         }
7702         assert_ne!(feerate_3, 0);
7703
7704         nodes[1].node.get_and_clear_pending_events();
7705         nodes[1].node.get_and_clear_pending_msg_events();
7706 }
7707
7708 #[test]
7709 fn test_bump_penalty_txn_on_revoked_htlcs() {
7710         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7711         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7712
7713         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7714         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7715         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7716         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7717         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7718
7719         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7720         // Lock HTLC in both directions
7721         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7722         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7723
7724         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7725         assert_eq!(revoked_local_txn[0].input.len(), 1);
7726         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7727
7728         // Revoke local commitment tx
7729         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7730
7731         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7732         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7733         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7734         check_closed_broadcast!(nodes[1], true);
7735         check_added_monitors!(nodes[1], 1);
7736
7737         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7738         assert_eq!(revoked_htlc_txn.len(), 4);
7739         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7740                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7741                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7742                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7743                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7744                 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7745                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7746         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7747                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7748                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7749                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7750                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7751                 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7752                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7753         }
7754
7755         // Broadcast set of revoked txn on A
7756         let hash_128 = connect_blocks(&nodes[0], 40);
7757         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7758         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7759         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7760         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] });
7761         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7762         let first;
7763         let feerate_1;
7764         let penalty_txn;
7765         {
7766                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7767                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7768                 // Verify claim tx are spending revoked HTLC txn
7769
7770                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7771                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7772                 // which are included in the same block (they are broadcasted because we scan the
7773                 // transactions linearly and generate claims as we go, they likely should be removed in the
7774                 // future).
7775                 assert_eq!(node_txn[0].input.len(), 1);
7776                 check_spends!(node_txn[0], revoked_local_txn[0]);
7777                 assert_eq!(node_txn[1].input.len(), 1);
7778                 check_spends!(node_txn[1], revoked_local_txn[0]);
7779                 assert_eq!(node_txn[2].input.len(), 1);
7780                 check_spends!(node_txn[2], revoked_local_txn[0]);
7781
7782                 // Each of the three justice transactions claim a separate (single) output of the three
7783                 // available, which we check here:
7784                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7785                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7786                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7787
7788                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7789                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7790
7791                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7792                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7793                 // a remote commitment tx has already been confirmed).
7794                 check_spends!(node_txn[3], chan.3);
7795
7796                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7797                 // output, checked above).
7798                 assert_eq!(node_txn[4].input.len(), 2);
7799                 assert_eq!(node_txn[4].output.len(), 1);
7800                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7801
7802                 first = node_txn[4].txid();
7803                 // Store both feerates for later comparison
7804                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7805                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7806                 penalty_txn = vec![node_txn[2].clone()];
7807                 node_txn.clear();
7808         }
7809
7810         // Connect one more block to see if bumped penalty are issued for HTLC txn
7811         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7812         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7813         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7814         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7815         {
7816                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7817                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7818
7819                 check_spends!(node_txn[0], revoked_local_txn[0]);
7820                 check_spends!(node_txn[1], revoked_local_txn[0]);
7821                 // Note that these are both bogus - they spend outputs already claimed in block 129:
7822                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
7823                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7824                 } else {
7825                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7826                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7827                 }
7828
7829                 node_txn.clear();
7830         };
7831
7832         // Few more blocks to confirm penalty txn
7833         connect_blocks(&nodes[0], 4);
7834         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7835         let header_144 = connect_blocks(&nodes[0], 9);
7836         let node_txn = {
7837                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7838                 assert_eq!(node_txn.len(), 1);
7839
7840                 assert_eq!(node_txn[0].input.len(), 2);
7841                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7842                 // Verify bumped tx is different and 25% bump heuristic
7843                 assert_ne!(first, node_txn[0].txid());
7844                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7845                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7846                 assert!(feerate_2 * 100 > feerate_1 * 125);
7847                 let txn = vec![node_txn[0].clone()];
7848                 node_txn.clear();
7849                 txn
7850         };
7851         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7852         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7853         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
7854         connect_blocks(&nodes[0], 20);
7855         {
7856                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7857                 // We verify than no new transaction has been broadcast because previously
7858                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7859                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7860                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7861                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7862                 // up bumped justice generation.
7863                 assert_eq!(node_txn.len(), 0);
7864                 node_txn.clear();
7865         }
7866         check_closed_broadcast!(nodes[0], true);
7867         check_added_monitors!(nodes[0], 1);
7868 }
7869
7870 #[test]
7871 fn test_bump_penalty_txn_on_remote_commitment() {
7872         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7873         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7874
7875         // Create 2 HTLCs
7876         // Provide preimage for one
7877         // Check aggregation
7878
7879         let chanmon_cfgs = create_chanmon_cfgs(2);
7880         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7881         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7882         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7883
7884         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7885         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7886         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7887
7888         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7889         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7890         assert_eq!(remote_txn[0].output.len(), 4);
7891         assert_eq!(remote_txn[0].input.len(), 1);
7892         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7893
7894         // Claim a HTLC without revocation (provide B monitor with preimage)
7895         nodes[1].node.claim_funds(payment_preimage);
7896         mine_transaction(&nodes[1], &remote_txn[0]);
7897         check_added_monitors!(nodes[1], 2);
7898
7899         // One or more claim tx should have been broadcast, check it
7900         let timeout;
7901         let preimage;
7902         let feerate_timeout;
7903         let feerate_preimage;
7904         {
7905                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7906                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7907                 assert_eq!(node_txn[0].input.len(), 1);
7908                 assert_eq!(node_txn[1].input.len(), 1);
7909                 check_spends!(node_txn[0], remote_txn[0]);
7910                 check_spends!(node_txn[1], remote_txn[0]);
7911                 check_spends!(node_txn[2], chan.3);
7912                 check_spends!(node_txn[3], node_txn[2]);
7913                 check_spends!(node_txn[4], node_txn[2]);
7914                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7915                         timeout = node_txn[0].txid();
7916                         let index = node_txn[0].input[0].previous_output.vout;
7917                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7918                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7919
7920                         preimage = node_txn[1].txid();
7921                         let index = node_txn[1].input[0].previous_output.vout;
7922                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7923                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7924                 } else {
7925                         timeout = node_txn[1].txid();
7926                         let index = node_txn[1].input[0].previous_output.vout;
7927                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7928                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7929
7930                         preimage = node_txn[0].txid();
7931                         let index = node_txn[0].input[0].previous_output.vout;
7932                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7933                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7934                 }
7935                 node_txn.clear();
7936         };
7937         assert_ne!(feerate_timeout, 0);
7938         assert_ne!(feerate_preimage, 0);
7939
7940         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7941         connect_blocks(&nodes[1], 15);
7942         {
7943                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7944                 assert_eq!(node_txn.len(), 2);
7945                 assert_eq!(node_txn[0].input.len(), 1);
7946                 assert_eq!(node_txn[1].input.len(), 1);
7947                 check_spends!(node_txn[0], remote_txn[0]);
7948                 check_spends!(node_txn[1], remote_txn[0]);
7949                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7950                         let index = node_txn[0].input[0].previous_output.vout;
7951                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7952                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7953                         assert!(new_feerate * 100 > feerate_timeout * 125);
7954                         assert_ne!(timeout, node_txn[0].txid());
7955
7956                         let index = node_txn[1].input[0].previous_output.vout;
7957                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7958                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7959                         assert!(new_feerate * 100 > feerate_preimage * 125);
7960                         assert_ne!(preimage, node_txn[1].txid());
7961                 } else {
7962                         let index = node_txn[1].input[0].previous_output.vout;
7963                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7964                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7965                         assert!(new_feerate * 100 > feerate_timeout * 125);
7966                         assert_ne!(timeout, node_txn[1].txid());
7967
7968                         let index = node_txn[0].input[0].previous_output.vout;
7969                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7970                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7971                         assert!(new_feerate * 100 > feerate_preimage * 125);
7972                         assert_ne!(preimage, node_txn[0].txid());
7973                 }
7974                 node_txn.clear();
7975         }
7976
7977         nodes[1].node.get_and_clear_pending_events();
7978         nodes[1].node.get_and_clear_pending_msg_events();
7979 }
7980
7981 #[test]
7982 fn test_counterparty_raa_skip_no_crash() {
7983         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7984         // commitment transaction, we would have happily carried on and provided them the next
7985         // commitment transaction based on one RAA forward. This would probably eventually have led to
7986         // channel closure, but it would not have resulted in funds loss. Still, our
7987         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
7988         // check simply that the channel is closed in response to such an RAA, but don't check whether
7989         // we decide to punish our counterparty for revoking their funds (as we don't currently
7990         // implement that).
7991         let chanmon_cfgs = create_chanmon_cfgs(2);
7992         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7993         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7994         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7995         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
7996
7997         let mut guard = nodes[0].node.channel_state.lock().unwrap();
7998         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
7999         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8000         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8001         // Must revoke without gaps
8002         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
8003         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8004                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8005
8006         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8007                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8008         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8009         check_added_monitors!(nodes[1], 1);
8010 }
8011
8012 #[test]
8013 fn test_bump_txn_sanitize_tracking_maps() {
8014         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8015         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8016
8017         let chanmon_cfgs = create_chanmon_cfgs(2);
8018         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8019         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8020         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8021
8022         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8023         // Lock HTLC in both directions
8024         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8025         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8026
8027         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8028         assert_eq!(revoked_local_txn[0].input.len(), 1);
8029         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8030
8031         // Revoke local commitment tx
8032         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8033
8034         // Broadcast set of revoked txn on A
8035         connect_blocks(&nodes[0], 52 - CHAN_CONFIRM_DEPTH);
8036         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8037         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8038
8039         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8040         check_closed_broadcast!(nodes[0], true);
8041         check_added_monitors!(nodes[0], 1);
8042         let penalty_txn = {
8043                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8044                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8045                 check_spends!(node_txn[0], revoked_local_txn[0]);
8046                 check_spends!(node_txn[1], revoked_local_txn[0]);
8047                 check_spends!(node_txn[2], revoked_local_txn[0]);
8048                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8049                 node_txn.clear();
8050                 penalty_txn
8051         };
8052         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8053         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8054         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8055         {
8056                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8057                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8058                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8059                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8060                 }
8061         }
8062 }
8063
8064 #[test]
8065 fn test_override_channel_config() {
8066         let chanmon_cfgs = create_chanmon_cfgs(2);
8067         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8068         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8069         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8070
8071         // Node0 initiates a channel to node1 using the override config.
8072         let mut override_config = UserConfig::default();
8073         override_config.own_channel_config.our_to_self_delay = 200;
8074
8075         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8076
8077         // Assert the channel created by node0 is using the override config.
8078         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8079         assert_eq!(res.channel_flags, 0);
8080         assert_eq!(res.to_self_delay, 200);
8081 }
8082
8083 #[test]
8084 fn test_override_0msat_htlc_minimum() {
8085         let mut zero_config = UserConfig::default();
8086         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8087         let chanmon_cfgs = create_chanmon_cfgs(2);
8088         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8089         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8090         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8091
8092         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8093         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8094         assert_eq!(res.htlc_minimum_msat, 1);
8095
8096         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8097         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8098         assert_eq!(res.htlc_minimum_msat, 1);
8099 }
8100
8101 #[test]
8102 fn test_simple_mpp() {
8103         // Simple test of sending a multi-path payment.
8104         let chanmon_cfgs = create_chanmon_cfgs(4);
8105         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8106         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8107         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8108
8109         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8110         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8111         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8112         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8113         let logger = test_utils::TestLogger::new();
8114
8115         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8116         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8117         let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8118         let path = route.paths[0].clone();
8119         route.paths.push(path);
8120         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8121         route.paths[0][0].short_channel_id = chan_1_id;
8122         route.paths[0][1].short_channel_id = chan_3_id;
8123         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8124         route.paths[1][0].short_channel_id = chan_2_id;
8125         route.paths[1][1].short_channel_id = chan_4_id;
8126         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8127         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
8128 }
8129
8130 #[test]
8131 fn test_preimage_storage() {
8132         // Simple test of payment preimage storage allowing no client-side storage to claim payments
8133         let chanmon_cfgs = create_chanmon_cfgs(2);
8134         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8135         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8136         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8137
8138         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8139
8140         {
8141                 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 7200, 42);
8142
8143                 let logger = test_utils::TestLogger::new();
8144                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8145                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8146                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8147                 check_added_monitors!(nodes[0], 1);
8148                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8149                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8150                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8151                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8152         }
8153         // Note that after leaving the above scope we have no knowledge of any arguments or return
8154         // values from previous calls.
8155         expect_pending_htlcs_forwardable!(nodes[1]);
8156         let events = nodes[1].node.get_and_clear_pending_events();
8157         assert_eq!(events.len(), 1);
8158         match events[0] {
8159                 Event::PaymentReceived { payment_preimage, user_payment_id, .. } => {
8160                         assert_eq!(user_payment_id, 42);
8161                         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage.unwrap());
8162                 },
8163                 _ => panic!("Unexpected event"),
8164         }
8165 }
8166
8167 #[test]
8168 fn test_secret_timeout() {
8169         // Simple test of payment secret storage time outs
8170         let chanmon_cfgs = create_chanmon_cfgs(2);
8171         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8172         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8173         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8174
8175         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8176
8177         let (payment_hash, payment_secret_1) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8178
8179         // We should fail to register the same payment hash twice, at least until we've connected a
8180         // block with time 7200 + CHAN_CONFIRM_DEPTH + 1.
8181         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8182                 assert_eq!(err, "Duplicate payment hash");
8183         } else { panic!(); }
8184         let mut block = Block {
8185                 header: BlockHeader {
8186                         version: 0x2000000,
8187                         prev_blockhash: nodes[1].blocks.borrow().last().unwrap().0.block_hash(),
8188                         merkle_root: Default::default(),
8189                         time: nodes[1].blocks.borrow().len() as u32 + 7200, bits: 42, nonce: 42 },
8190                 txdata: vec![],
8191         };
8192         connect_block(&nodes[1], &block);
8193         if let Err(APIError::APIMisuseError { err }) = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 0) {
8194                 assert_eq!(err, "Duplicate payment hash");
8195         } else { panic!(); }
8196
8197         // If we then connect the second block, we should be able to register the same payment hash
8198         // again with a different user_payment_id (this time getting a new payment secret).
8199         block.header.prev_blockhash = block.header.block_hash();
8200         block.header.time += 1;
8201         connect_block(&nodes[1], &block);
8202         let our_payment_secret = nodes[1].node.create_inbound_payment_for_hash(payment_hash, Some(100_000), 2, 42).unwrap();
8203         assert_ne!(payment_secret_1, our_payment_secret);
8204
8205         {
8206                 let logger = test_utils::TestLogger::new();
8207                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8208                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8209                 nodes[0].node.send_payment(&route, payment_hash, &Some(our_payment_secret)).unwrap();
8210                 check_added_monitors!(nodes[0], 1);
8211                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8212                 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
8213                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8214                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8215         }
8216         // Note that after leaving the above scope we have no knowledge of any arguments or return
8217         // values from previous calls.
8218         expect_pending_htlcs_forwardable!(nodes[1]);
8219         let events = nodes[1].node.get_and_clear_pending_events();
8220         assert_eq!(events.len(), 1);
8221         match events[0] {
8222                 Event::PaymentReceived { payment_preimage, payment_secret, user_payment_id, .. } => {
8223                         assert!(payment_preimage.is_none());
8224                         assert_eq!(user_payment_id, 42);
8225                         assert_eq!(payment_secret, our_payment_secret);
8226                         // We don't actually have the payment preimage with which to claim this payment!
8227                 },
8228                 _ => panic!("Unexpected event"),
8229         }
8230 }
8231
8232 #[test]
8233 fn test_bad_secret_hash() {
8234         // Simple test of unregistered payment hash/invalid payment secret handling
8235         let chanmon_cfgs = create_chanmon_cfgs(2);
8236         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8237         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8238         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8239
8240         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8241
8242         let random_payment_hash = PaymentHash([42; 32]);
8243         let random_payment_secret = PaymentSecret([43; 32]);
8244         let (our_payment_hash, our_payment_secret) = nodes[1].node.create_inbound_payment(Some(100_000), 2, 0);
8245
8246         let logger = test_utils::TestLogger::new();
8247         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8248         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100_000, TEST_FINAL_CLTV, &logger).unwrap();
8249
8250         // All the below cases should end up being handled exactly identically, so we macro the
8251         // resulting events.
8252         macro_rules! handle_unknown_invalid_payment_data {
8253                 () => {
8254                         check_added_monitors!(nodes[0], 1);
8255                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
8256                         let payment_event = SendEvent::from_event(events.pop().unwrap());
8257                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
8258                         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
8259
8260                         // We have to forward pending HTLCs once to process the receipt of the HTLC and then
8261                         // again to process the pending backwards-failure of the HTLC
8262                         expect_pending_htlcs_forwardable!(nodes[1]);
8263                         expect_pending_htlcs_forwardable!(nodes[1]);
8264                         check_added_monitors!(nodes[1], 1);
8265
8266                         // We should fail the payment back
8267                         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
8268                         match events.pop().unwrap() {
8269                                 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } } => {
8270                                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
8271                                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
8272                                 },
8273                                 _ => panic!("Unexpected event"),
8274                         }
8275                 }
8276         }
8277
8278         let expected_error_code = 0x4000|15; // incorrect_or_unknown_payment_details
8279         // Error data is the HTLC value (100,000) and current block height
8280         let expected_error_data = [0, 0, 0, 0, 0, 1, 0x86, 0xa0, 0, 0, 0, CHAN_CONFIRM_DEPTH as u8];
8281
8282         // Send a payment with the right payment hash but the wrong payment secret
8283         nodes[0].node.send_payment(&route, our_payment_hash, &Some(random_payment_secret)).unwrap();
8284         handle_unknown_invalid_payment_data!();
8285         expect_payment_failed!(nodes[0], our_payment_hash, true, expected_error_code, expected_error_data);
8286
8287         // Send a payment with a random payment hash, but the right payment secret
8288         nodes[0].node.send_payment(&route, random_payment_hash, &Some(our_payment_secret)).unwrap();
8289         handle_unknown_invalid_payment_data!();
8290         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8291
8292         // Send a payment with a random payment hash and random payment secret
8293         nodes[0].node.send_payment(&route, random_payment_hash, &Some(random_payment_secret)).unwrap();
8294         handle_unknown_invalid_payment_data!();
8295         expect_payment_failed!(nodes[0], random_payment_hash, true, expected_error_code, expected_error_data);
8296 }
8297
8298 #[test]
8299 fn test_update_err_monitor_lockdown() {
8300         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8301         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8302         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8303         //
8304         // This scenario may happen in a watchtower setup, where watchtower process a block height
8305         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8306         // commitment at same time.
8307
8308         let chanmon_cfgs = create_chanmon_cfgs(2);
8309         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8310         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8311         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8312
8313         // Create some initial channel
8314         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8315         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8316
8317         // Rebalance the network to generate htlc in the two directions
8318         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8319
8320         // Route a HTLC from node 0 to node 1 (but don't settle)
8321         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8322
8323         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8324         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8325         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8326         let persister = test_utils::TestPersister::new();
8327         let watchtower = {
8328                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8329                 let monitor = monitors.get(&outpoint).unwrap();
8330                 let mut w = test_utils::TestVecWriter(Vec::new());
8331                 monitor.write(&mut w).unwrap();
8332                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8333                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8334                 assert!(new_monitor == *monitor);
8335                 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8336                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8337                 watchtower
8338         };
8339         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8340         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8341
8342         // Try to update ChannelMonitor
8343         assert!(nodes[1].node.claim_funds(preimage));
8344         check_added_monitors!(nodes[1], 1);
8345         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8346         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8347         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8348         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8349                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8350                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8351                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8352                 } else { assert!(false); }
8353         } else { assert!(false); };
8354         // Our local monitor is in-sync and hasn't processed yet timeout
8355         check_added_monitors!(nodes[0], 1);
8356         let events = nodes[0].node.get_and_clear_pending_events();
8357         assert_eq!(events.len(), 1);
8358 }
8359
8360 #[test]
8361 fn test_concurrent_monitor_claim() {
8362         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8363         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8364         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8365         // state N+1 confirms. Alice claims output from state N+1.
8366
8367         let chanmon_cfgs = create_chanmon_cfgs(2);
8368         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8369         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8370         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8371
8372         // Create some initial channel
8373         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8374         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8375
8376         // Rebalance the network to generate htlc in the two directions
8377         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000);
8378
8379         // Route a HTLC from node 0 to node 1 (but don't settle)
8380         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8381
8382         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8383         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8384         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8385         let persister = test_utils::TestPersister::new();
8386         let watchtower_alice = {
8387                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8388                 let monitor = monitors.get(&outpoint).unwrap();
8389                 let mut w = test_utils::TestVecWriter(Vec::new());
8390                 monitor.write(&mut w).unwrap();
8391                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8392                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8393                 assert!(new_monitor == *monitor);
8394                 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8395                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8396                 watchtower
8397         };
8398         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8399         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8400
8401         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8402         {
8403                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8404                 assert_eq!(txn.len(), 2);
8405                 txn.clear();
8406         }
8407
8408         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8409         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8410         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8411         let persister = test_utils::TestPersister::new();
8412         let watchtower_bob = {
8413                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8414                 let monitor = monitors.get(&outpoint).unwrap();
8415                 let mut w = test_utils::TestVecWriter(Vec::new());
8416                 monitor.write(&mut w).unwrap();
8417                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8418                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8419                 assert!(new_monitor == *monitor);
8420                 let watchtower = test_utils::TestChainMonitor::new(Some(&chain_source), &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator, &persister, &node_cfgs[0].keys_manager);
8421                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8422                 watchtower
8423         };
8424         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8425         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8426
8427         // Route another payment to generate another update with still previous HTLC pending
8428         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8429         {
8430                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8431                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 3000000 , TEST_FINAL_CLTV, &logger).unwrap();
8432                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8433         }
8434         check_added_monitors!(nodes[1], 1);
8435
8436         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8437         assert_eq!(updates.update_add_htlcs.len(), 1);
8438         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8439         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8440                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8441                         // Watchtower Alice should already have seen the block and reject the update
8442                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8443                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8444                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8445                 } else { assert!(false); }
8446         } else { assert!(false); };
8447         // Our local monitor is in-sync and hasn't processed yet timeout
8448         check_added_monitors!(nodes[0], 1);
8449
8450         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8451         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8452         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8453
8454         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8455         let bob_state_y;
8456         {
8457                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8458                 assert_eq!(txn.len(), 2);
8459                 bob_state_y = txn[0].clone();
8460                 txn.clear();
8461         };
8462
8463         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8464         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8465         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![bob_state_y.clone()] }, CHAN_CONFIRM_DEPTH + 2 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8466         {
8467                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8468                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8469                 // the onchain detection of the HTLC output
8470                 assert_eq!(htlc_txn.len(), 2);
8471                 check_spends!(htlc_txn[0], bob_state_y);
8472                 check_spends!(htlc_txn[1], bob_state_y);
8473         }
8474 }
8475
8476 #[test]
8477 fn test_pre_lockin_no_chan_closed_update() {
8478         // Test that if a peer closes a channel in response to a funding_created message we don't
8479         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8480         // message).
8481         //
8482         // Doing so would imply a channel monitor update before the initial channel monitor
8483         // registration, violating our API guarantees.
8484         //
8485         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8486         // then opening a second channel with the same funding output as the first (which is not
8487         // rejected because the first channel does not exist in the ChannelManager) and closing it
8488         // before receiving funding_signed.
8489         let chanmon_cfgs = create_chanmon_cfgs(2);
8490         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8491         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8492         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8493
8494         // Create an initial channel
8495         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8496         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8497         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8498         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8499         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8500
8501         // Move the first channel through the funding flow...
8502         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8503
8504         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8505         check_added_monitors!(nodes[0], 0);
8506
8507         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8508         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8509         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8510         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8511 }
8512
8513 #[test]
8514 fn test_htlc_no_detection() {
8515         // This test is a mutation to underscore the detection logic bug we had
8516         // before #653. HTLC value routed is above the remaining balance, thus
8517         // inverting HTLC and `to_remote` output. HTLC will come second and
8518         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8519         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8520         // outputs order detection for correct spending children filtring.
8521
8522         let chanmon_cfgs = create_chanmon_cfgs(2);
8523         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8524         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8525         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8526
8527         // Create some initial channels
8528         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8529
8530         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000);
8531         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8532         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8533         assert_eq!(local_txn[0].input.len(), 1);
8534         assert_eq!(local_txn[0].output.len(), 3);
8535         check_spends!(local_txn[0], chan_1.3);
8536
8537         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8538         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8539         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8540         // We deliberately connect the local tx twice as this should provoke a failure calling
8541         // this test before #653 fix.
8542         chain::Listen::block_connected(&nodes[0].chain_monitor.chain_monitor, &Block { header, txdata: vec![local_txn[0].clone()] }, nodes[0].best_block_info().1 + 1);
8543         check_closed_broadcast!(nodes[0], true);
8544         check_added_monitors!(nodes[0], 1);
8545
8546         let htlc_timeout = {
8547                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8548                 assert_eq!(node_txn[0].input.len(), 1);
8549                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8550                 check_spends!(node_txn[0], local_txn[0]);
8551                 node_txn[0].clone()
8552         };
8553
8554         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8555         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8556         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8557         expect_payment_failed!(nodes[0], our_payment_hash, true);
8558 }
8559
8560 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8561         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8562         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8563         // Carol, Alice would be the upstream node, and Carol the downstream.)
8564         //
8565         // Steps of the test:
8566         // 1) Alice sends a HTLC to Carol through Bob.
8567         // 2) Carol doesn't settle the HTLC.
8568         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8569         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8570         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8571         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8572         // 5) Carol release the preimage to Bob off-chain.
8573         // 6) Bob claims the offered output on the broadcasted commitment.
8574         let chanmon_cfgs = create_chanmon_cfgs(3);
8575         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8576         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8577         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8578
8579         // Create some initial channels
8580         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8581         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8582
8583         // Steps (1) and (2):
8584         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8585         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8586
8587         // Check that Alice's commitment transaction now contains an output for this HTLC.
8588         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8589         check_spends!(alice_txn[0], chan_ab.3);
8590         assert_eq!(alice_txn[0].output.len(), 2);
8591         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8592         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8593         assert_eq!(alice_txn.len(), 2);
8594
8595         // Steps (3) and (4):
8596         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8597         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8598         let mut force_closing_node = 0; // Alice force-closes
8599         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8600         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8601         check_closed_broadcast!(nodes[force_closing_node], true);
8602         check_added_monitors!(nodes[force_closing_node], 1);
8603         if go_onchain_before_fulfill {
8604                 let txn_to_broadcast = match broadcast_alice {
8605                         true => alice_txn.clone(),
8606                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8607                 };
8608                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8609                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8610                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8611                 if broadcast_alice {
8612                         check_closed_broadcast!(nodes[1], true);
8613                         check_added_monitors!(nodes[1], 1);
8614                 }
8615                 assert_eq!(bob_txn.len(), 1);
8616                 check_spends!(bob_txn[0], chan_ab.3);
8617         }
8618
8619         // Step (5):
8620         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8621         // process of removing the HTLC from their commitment transactions.
8622         assert!(nodes[2].node.claim_funds(payment_preimage));
8623         check_added_monitors!(nodes[2], 1);
8624         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8625         assert!(carol_updates.update_add_htlcs.is_empty());
8626         assert!(carol_updates.update_fail_htlcs.is_empty());
8627         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8628         assert!(carol_updates.update_fee.is_none());
8629         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8630
8631         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8632         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8633         if !go_onchain_before_fulfill && broadcast_alice {
8634                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8635                 assert_eq!(events.len(), 1);
8636                 match events[0] {
8637                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8638                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8639                         },
8640                         _ => panic!("Unexpected event"),
8641                 };
8642         }
8643         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8644         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8645         // Carol<->Bob's updated commitment transaction info.
8646         check_added_monitors!(nodes[1], 2);
8647
8648         let events = nodes[1].node.get_and_clear_pending_msg_events();
8649         assert_eq!(events.len(), 2);
8650         let bob_revocation = match events[0] {
8651                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8652                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8653                         (*msg).clone()
8654                 },
8655                 _ => panic!("Unexpected event"),
8656         };
8657         let bob_updates = match events[1] {
8658                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8659                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8660                         (*updates).clone()
8661                 },
8662                 _ => panic!("Unexpected event"),
8663         };
8664
8665         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8666         check_added_monitors!(nodes[2], 1);
8667         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8668         check_added_monitors!(nodes[2], 1);
8669
8670         let events = nodes[2].node.get_and_clear_pending_msg_events();
8671         assert_eq!(events.len(), 1);
8672         let carol_revocation = match events[0] {
8673                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8674                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8675                         (*msg).clone()
8676                 },
8677                 _ => panic!("Unexpected event"),
8678         };
8679         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8680         check_added_monitors!(nodes[1], 1);
8681
8682         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8683         // here's where we put said channel's commitment tx on-chain.
8684         let mut txn_to_broadcast = alice_txn.clone();
8685         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8686         if !go_onchain_before_fulfill {
8687                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8688                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8689                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8690                 if broadcast_alice {
8691                         check_closed_broadcast!(nodes[1], true);
8692                         check_added_monitors!(nodes[1], 1);
8693                 }
8694                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8695                 if broadcast_alice {
8696                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8697                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8698                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8699                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8700                         // broadcasted.
8701                         assert_eq!(bob_txn.len(), 3);
8702                         check_spends!(bob_txn[1], chan_ab.3);
8703                 } else {
8704                         assert_eq!(bob_txn.len(), 2);
8705                         check_spends!(bob_txn[0], chan_ab.3);
8706                 }
8707         }
8708
8709         // Step (6):
8710         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8711         // broadcasted commitment transaction.
8712         {
8713                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8714                 if go_onchain_before_fulfill {
8715                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8716                         assert_eq!(bob_txn.len(), 2);
8717                 }
8718                 let script_weight = match broadcast_alice {
8719                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8720                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8721                 };
8722                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8723                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8724                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8725                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8726                 if broadcast_alice && !go_onchain_before_fulfill {
8727                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8728                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8729                 } else {
8730                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8731                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8732                 }
8733         }
8734 }
8735
8736 #[test]
8737 fn test_onchain_htlc_settlement_after_close() {
8738         do_test_onchain_htlc_settlement_after_close(true, true);
8739         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8740         do_test_onchain_htlc_settlement_after_close(true, false);
8741         do_test_onchain_htlc_settlement_after_close(false, false);
8742 }
8743
8744 #[test]
8745 fn test_duplicate_chan_id() {
8746         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8747         // already open we reject it and keep the old channel.
8748         //
8749         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8750         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8751         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8752         // updating logic for the existing channel.
8753         let chanmon_cfgs = create_chanmon_cfgs(2);
8754         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8755         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8756         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8757
8758         // Create an initial channel
8759         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8760         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8761         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8762         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8763
8764         // Try to create a second channel with the same temporary_channel_id as the first and check
8765         // that it is rejected.
8766         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8767         {
8768                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8769                 assert_eq!(events.len(), 1);
8770                 match events[0] {
8771                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8772                                 // Technically, at this point, nodes[1] would be justified in thinking both the
8773                                 // first (valid) and second (invalid) channels are closed, given they both have
8774                                 // the same non-temporary channel_id. However, currently we do not, so we just
8775                                 // move forward with it.
8776                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8777                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8778                         },
8779                         _ => panic!("Unexpected event"),
8780                 }
8781         }
8782
8783         // Move the first channel through the funding flow...
8784         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8785
8786         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8787         check_added_monitors!(nodes[0], 0);
8788
8789         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8790         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8791         {
8792                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8793                 assert_eq!(added_monitors.len(), 1);
8794                 assert_eq!(added_monitors[0].0, funding_output);
8795                 added_monitors.clear();
8796         }
8797         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8798
8799         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8800         let channel_id = funding_outpoint.to_channel_id();
8801
8802         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8803         // temporary one).
8804
8805         // First try to open a second channel with a temporary channel id equal to the txid-based one.
8806         // Technically this is allowed by the spec, but we don't support it and there's little reason
8807         // to. Still, it shouldn't cause any other issues.
8808         open_chan_msg.temporary_channel_id = channel_id;
8809         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8810         {
8811                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8812                 assert_eq!(events.len(), 1);
8813                 match events[0] {
8814                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8815                                 // Technically, at this point, nodes[1] would be justified in thinking both
8816                                 // channels are closed, but currently we do not, so we just move forward with it.
8817                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8818                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8819                         },
8820                         _ => panic!("Unexpected event"),
8821                 }
8822         }
8823
8824         // Now try to create a second channel which has a duplicate funding output.
8825         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8826         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8827         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8828         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8829         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8830
8831         let funding_created = {
8832                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8833                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8834                 let logger = test_utils::TestLogger::new();
8835                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8836         };
8837         check_added_monitors!(nodes[0], 0);
8838         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8839         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8840         // still needs to be cleared here.
8841         check_added_monitors!(nodes[1], 1);
8842
8843         // ...still, nodes[1] will reject the duplicate channel.
8844         {
8845                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8846                 assert_eq!(events.len(), 1);
8847                 match events[0] {
8848                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8849                                 // Technically, at this point, nodes[1] would be justified in thinking both
8850                                 // channels are closed, but currently we do not, so we just move forward with it.
8851                                 assert_eq!(msg.channel_id, channel_id);
8852                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8853                         },
8854                         _ => panic!("Unexpected event"),
8855                 }
8856         }
8857
8858         // finally, finish creating the original channel and send a payment over it to make sure
8859         // everything is functional.
8860         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8861         {
8862                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8863                 assert_eq!(added_monitors.len(), 1);
8864                 assert_eq!(added_monitors[0].0, funding_output);
8865                 added_monitors.clear();
8866         }
8867
8868         let events_4 = nodes[0].node.get_and_clear_pending_events();
8869         assert_eq!(events_4.len(), 0);
8870         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8871         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
8872
8873         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8874         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8875         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8876         send_payment(&nodes[0], &[&nodes[1]], 8000000);
8877 }
8878
8879 #[test]
8880 fn test_error_chans_closed() {
8881         // Test that we properly handle error messages, closing appropriate channels.
8882         //
8883         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8884         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8885         // we can test various edge cases around it to ensure we don't regress.
8886         let chanmon_cfgs = create_chanmon_cfgs(3);
8887         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8888         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8889         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8890
8891         // Create some initial channels
8892         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8893         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8894         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8895
8896         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8897         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8898         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8899
8900         // Closing a channel from a different peer has no effect
8901         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8902         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8903
8904         // Closing one channel doesn't impact others
8905         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8906         check_added_monitors!(nodes[0], 1);
8907         check_closed_broadcast!(nodes[0], false);
8908         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
8909         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8910         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_1.2 || nodes[0].node.list_usable_channels()[1].channel_id == chan_1.2);
8911         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2 || nodes[0].node.list_usable_channels()[1].channel_id == chan_3.2);
8912
8913         // A null channel ID should close all channels
8914         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8915         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8916         check_added_monitors!(nodes[0], 2);
8917         let events = nodes[0].node.get_and_clear_pending_msg_events();
8918         assert_eq!(events.len(), 2);
8919         match events[0] {
8920                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8921                         assert_eq!(msg.contents.flags & 2, 2);
8922                 },
8923                 _ => panic!("Unexpected event"),
8924         }
8925         match events[1] {
8926                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8927                         assert_eq!(msg.contents.flags & 2, 2);
8928                 },
8929                 _ => panic!("Unexpected event"),
8930         }
8931         // Note that at this point users of a standard PeerHandler will end up calling
8932         // peer_disconnected with no_connection_possible set to false, duplicating the
8933         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8934         // users with their own peer handling logic. We duplicate the call here, however.
8935         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8936         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8937
8938         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8939         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8940         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8941 }
8942
8943 #[test]
8944 fn test_invalid_funding_tx() {
8945         // Test that we properly handle invalid funding transactions sent to us from a peer.
8946         //
8947         // Previously, all other major lightning implementations had failed to properly sanitize
8948         // funding transactions from their counterparties, leading to a multi-implementation critical
8949         // security vulnerability (though we always sanitized properly, we've previously had
8950         // un-released crashes in the sanitization process).
8951         let chanmon_cfgs = create_chanmon_cfgs(2);
8952         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8953         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8954         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8955
8956         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
8957         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
8958         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id()));
8959
8960         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
8961         for output in tx.output.iter_mut() {
8962                 // Make the confirmed funding transaction have a bogus script_pubkey
8963                 output.script_pubkey = bitcoin::Script::new();
8964         }
8965
8966         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
8967         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id()));
8968         check_added_monitors!(nodes[1], 1);
8969
8970         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id()));
8971         check_added_monitors!(nodes[0], 1);
8972
8973         let events_1 = nodes[0].node.get_and_clear_pending_events();
8974         assert_eq!(events_1.len(), 0);
8975
8976         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8977         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8978         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
8979
8980         confirm_transaction_at(&nodes[1], &tx, 1);
8981         check_added_monitors!(nodes[1], 1);
8982         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
8983         assert_eq!(events_2.len(), 1);
8984         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
8985                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8986                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
8987                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
8988                 } else { panic!(); }
8989         } else { panic!(); }
8990         assert_eq!(nodes[1].node.list_channels().len(), 0);
8991 }