_ 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, 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, 8_000_000);
 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, 8_000_000);
 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, 8_000_000);
 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, 800_000);
 709
 710         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 711         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 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, &Some(payment_secret), 100_000));
 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, _, our_payment_secret) = 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, &Some(our_payment_secret), 100_000));
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, 8_000_000);
1179         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1180         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1181         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1182
1183         // Send some more payments
1184         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1185         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1186         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
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, 1_000_000);
1196         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1197         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1198         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1199         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1200         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1201         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
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, 1_000_000);
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, 3_000_000);
1283         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1284         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
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, 100_000);
1419         }
1420
1421         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
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, 1_000_000);
1449         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1450         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
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.
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, 8_000_000);
1468
1469         let (payment_preimage, payment_hash, payment_secret) = 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, &Some(payment_secret), 800_000);
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, 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, 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_secret, amt, user_payment_id: _ } => {
2074                         assert_eq!(our_payment_hash_21, *payment_hash);
2075                         assert_eq!(Some(our_payment_secret_21), *payment_secret);
2076                         assert_eq!(recv_value_21, amt);
2077                 },
2078                 _ => panic!("Unexpected event"),
2079         }
2080         match events[1] {
2081                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt, user_payment_id: _ } => {
2082                         assert_eq!(our_payment_hash_22, *payment_hash);
2083                         assert_eq!(Some(our_payment_secret_22), *payment_secret);
2084                         assert_eq!(recv_value_22, amt);
2085                 },
2086                 _ => panic!("Unexpected event"),
2087         }
2088
2089         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2090         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2091         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2092
2093         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2094         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2095         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2096
2097         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2098         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);
2099         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2100         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2101         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2102
2103         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2104         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2105 }
2106
2107 #[test]
2108 fn channel_reserve_in_flight_removes() {
2109         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2110         // can send to its counterparty, but due to update ordering, the other side may not yet have
2111         // considered those HTLCs fully removed.
2112         // This tests that we don't count HTLCs which will not be included in the next remote
2113         // commitment transaction towards the reserve value (as it implies no commitment transaction
2114         // will be generated which violates the remote reserve value).
2115         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2116         // To test this we:
2117         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2118         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2119         //    you only consider the value of the first HTLC, it may not),
2120         //  * start routing a third HTLC from A to B,
2121         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2122         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2123         //  * deliver the first fulfill from B
2124         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2125         //    claim,
2126         //  * deliver A's response CS and RAA.
2127         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2128         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2129         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2130         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2131         let chanmon_cfgs = create_chanmon_cfgs(2);
2132         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2133         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2134         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2135         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2136         let logger = test_utils::TestLogger::new();
2137
2138         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2139         // Route the first two HTLCs.
2140         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2141         let (payment_preimage_2, _, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2142
2143         // Start routing the third HTLC (this is just used to get everyone in the right state).
2144         let (payment_preimage_3, payment_hash_3, payment_secret_3) = get_payment_preimage_hash!(nodes[1]);
2145         let send_1 = {
2146                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2147                 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();
2148                 nodes[0].node.send_payment(&route, payment_hash_3, &Some(payment_secret_3)).unwrap();
2149                 check_added_monitors!(nodes[0], 1);
2150                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2151                 assert_eq!(events.len(), 1);
2152                 SendEvent::from_event(events.remove(0))
2153         };
2154
2155         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2156         // initial fulfill/CS.
2157         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2158         check_added_monitors!(nodes[1], 1);
2159         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2160
2161         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2162         // remove the second HTLC when we send the HTLC back from B to A.
2163         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2164         check_added_monitors!(nodes[1], 1);
2165         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2166
2167         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2168         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2169         check_added_monitors!(nodes[0], 1);
2170         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2171         expect_payment_sent!(nodes[0], payment_preimage_1);
2172
2173         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2174         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2175         check_added_monitors!(nodes[1], 1);
2176         // B is already AwaitingRAA, so cant generate a CS here
2177         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2178
2179         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2180         check_added_monitors!(nodes[1], 1);
2181         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2182
2183         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2184         check_added_monitors!(nodes[0], 1);
2185         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2186
2187         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2188         check_added_monitors!(nodes[1], 1);
2189         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2190
2191         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2192         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2193         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2194         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2195         // on-chain as necessary).
2196         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2197         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2198         check_added_monitors!(nodes[0], 1);
2199         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2200         expect_payment_sent!(nodes[0], payment_preimage_2);
2201
2202         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2203         check_added_monitors!(nodes[1], 1);
2204         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2205
2206         expect_pending_htlcs_forwardable!(nodes[1]);
2207         expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 100000);
2208
2209         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2210         // resolve the second HTLC from A's point of view.
2211         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2212         check_added_monitors!(nodes[0], 1);
2213         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2214
2215         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2216         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2217         let (payment_preimage_4, payment_hash_4, payment_secret_4) = get_payment_preimage_hash!(nodes[0]);
2218         let send_2 = {
2219                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2220                 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();
2221                 nodes[1].node.send_payment(&route, payment_hash_4, &Some(payment_secret_4)).unwrap();
2222                 check_added_monitors!(nodes[1], 1);
2223                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2224                 assert_eq!(events.len(), 1);
2225                 SendEvent::from_event(events.remove(0))
2226         };
2227
2228         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2229         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2230         check_added_monitors!(nodes[0], 1);
2231         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2232
2233         // Now just resolve all the outstanding messages/HTLCs for completeness...
2234
2235         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2236         check_added_monitors!(nodes[1], 1);
2237         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2238
2239         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2240         check_added_monitors!(nodes[1], 1);
2241
2242         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2243         check_added_monitors!(nodes[0], 1);
2244         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2245
2246         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2247         check_added_monitors!(nodes[1], 1);
2248         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2249
2250         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2251         check_added_monitors!(nodes[0], 1);
2252
2253         expect_pending_htlcs_forwardable!(nodes[0]);
2254         expect_payment_received!(nodes[0], payment_hash_4, payment_secret_4, 10000);
2255
2256         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2257         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2258 }
2259
2260 #[test]
2261 fn channel_monitor_network_test() {
2262         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2263         // tests that ChannelMonitor is able to recover from various states.
2264         let chanmon_cfgs = create_chanmon_cfgs(5);
2265         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2266         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2267         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2268
2269         // Create some initial channels
2270         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2271         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2272         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2273         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2274
2275         // Make sure all nodes are at the same starting height
2276         connect_blocks(&nodes[0], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
2277         connect_blocks(&nodes[1], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
2278         connect_blocks(&nodes[2], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
2279         connect_blocks(&nodes[3], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[3].best_block_info().1);
2280         connect_blocks(&nodes[4], 4*CHAN_CONFIRM_DEPTH + 1 - nodes[4].best_block_info().1);
2281
2282         // Rebalance the network a bit by relaying one payment through all the channels...
2283         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2284         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2285         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2286         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2287
2288         // Simple case with no pending HTLCs:
2289         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2290         check_added_monitors!(nodes[1], 1);
2291         check_closed_broadcast!(nodes[1], false);
2292         {
2293                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2294                 assert_eq!(node_txn.len(), 1);
2295                 mine_transaction(&nodes[0], &node_txn[0]);
2296                 check_added_monitors!(nodes[0], 1);
2297                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2298         }
2299         check_closed_broadcast!(nodes[0], true);
2300         assert_eq!(nodes[0].node.list_channels().len(), 0);
2301         assert_eq!(nodes[1].node.list_channels().len(), 1);
2302
2303         // One pending HTLC is discarded by the force-close:
2304         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2305
2306         // Simple case of one pending HTLC to HTLC-Timeout
2307         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2308         check_closed_broadcast!(nodes[1], false);
2309         check_added_monitors!(nodes[1], 1);
2310         {
2311                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2312                 mine_transaction(&nodes[2], &node_txn[0]);
2313                 check_added_monitors!(nodes[2], 1);
2314                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2315         }
2316         check_closed_broadcast!(nodes[2], true);
2317         assert_eq!(nodes[1].node.list_channels().len(), 0);
2318         assert_eq!(nodes[2].node.list_channels().len(), 1);
2319
2320         macro_rules! claim_funds {
2321                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2322                         {
2323                                 assert!($node.node.claim_funds($preimage, &None, $amount));
2324                                 check_added_monitors!($node, 1);
2325
2326                                 let events = $node.node.get_and_clear_pending_msg_events();
2327                                 assert_eq!(events.len(), 1);
2328                                 match events[0] {
2329                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2330                                                 assert!(update_add_htlcs.is_empty());
2331                                                 assert!(update_fail_htlcs.is_empty());
2332                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2333                                         },
2334                                         _ => panic!("Unexpected event"),
2335                                 };
2336                         }
2337                 }
2338         }
2339
2340         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2341         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2342         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2343         check_added_monitors!(nodes[2], 1);
2344         check_closed_broadcast!(nodes[2], false);
2345         let node2_commitment_txid;
2346         {
2347                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2348                 node2_commitment_txid = node_txn[0].txid();
2349
2350                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2351                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2352                 mine_transaction(&nodes[3], &node_txn[0]);
2353                 check_added_monitors!(nodes[3], 1);
2354                 check_preimage_claim(&nodes[3], &node_txn);
2355         }
2356         check_closed_broadcast!(nodes[3], true);
2357         assert_eq!(nodes[2].node.list_channels().len(), 0);
2358         assert_eq!(nodes[3].node.list_channels().len(), 1);
2359
2360         // Drop the ChannelMonitor for the previous channel to avoid it broadcasting transactions and
2361         // confusing us in the following tests.
2362         let chan_3_mon = nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().remove(&OutPoint { txid: chan_3.3.txid(), index: 0 }).unwrap();
2363
2364         // One pending HTLC to time out:
2365         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2366         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2367         // buffer space).
2368
2369         let (close_chan_update_1, close_chan_update_2) = {
2370                 connect_blocks(&nodes[3], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2371                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2372                 assert_eq!(events.len(), 2);
2373                 let close_chan_update_1 = match events[0] {
2374                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2375                                 msg.clone()
2376                         },
2377                         _ => panic!("Unexpected event"),
2378                 };
2379                 match events[1] {
2380                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2381                                 assert_eq!(node_id, nodes[4].node.get_our_node_id());
2382                         },
2383                         _ => panic!("Unexpected event"),
2384                 }
2385                 check_added_monitors!(nodes[3], 1);
2386
2387                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2388                 {
2389                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2390                         node_txn.retain(|tx| {
2391                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2392                                         false
2393                                 } else { true }
2394                         });
2395                 }
2396
2397                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2398
2399                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2400                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2401
2402                 connect_blocks(&nodes[4], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + 2);
2403                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2404                 assert_eq!(events.len(), 2);
2405                 let close_chan_update_2 = match events[0] {
2406                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2407                                 msg.clone()
2408                         },
2409                         _ => panic!("Unexpected event"),
2410                 };
2411                 match events[1] {
2412                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id } => {
2413                                 assert_eq!(node_id, nodes[3].node.get_our_node_id());
2414                         },
2415                         _ => panic!("Unexpected event"),
2416                 }
2417                 check_added_monitors!(nodes[4], 1);
2418                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2419
2420                 mine_transaction(&nodes[4], &node_txn[0]);
2421                 check_preimage_claim(&nodes[4], &node_txn);
2422                 (close_chan_update_1, close_chan_update_2)
2423         };
2424         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2425         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2426         assert_eq!(nodes[3].node.list_channels().len(), 0);
2427         assert_eq!(nodes[4].node.list_channels().len(), 0);
2428
2429         nodes[3].chain_monitor.chain_monitor.monitors.write().unwrap().insert(OutPoint { txid: chan_3.3.txid(), index: 0 }, chan_3_mon);
2430 }
2431
2432 #[test]
2433 fn test_justice_tx() {
2434         // Test justice txn built on revoked HTLC-Success tx, against both sides
2435         let mut alice_config = UserConfig::default();
2436         alice_config.channel_options.announced_channel = true;
2437         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2438         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2439         let mut bob_config = UserConfig::default();
2440         bob_config.channel_options.announced_channel = true;
2441         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2442         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2443         let user_cfgs = [Some(alice_config), Some(bob_config)];
2444         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2445         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2446         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2447         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2448         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2449         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2450         // Create some new channels:
2451         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2452
2453         // A pending HTLC which will be revoked:
2454         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2455         // Get the will-be-revoked local txn from nodes[0]
2456         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2457         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2458         assert_eq!(revoked_local_txn[0].input.len(), 1);
2459         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2460         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2461         assert_eq!(revoked_local_txn[1].input.len(), 1);
2462         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2463         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2464         // Revoke the old state
2465         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2466
2467         {
2468                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2469                 {
2470                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2471                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2472                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2473
2474                         check_spends!(node_txn[0], revoked_local_txn[0]);
2475                         node_txn.swap_remove(0);
2476                         node_txn.truncate(1);
2477                 }
2478                 check_added_monitors!(nodes[1], 1);
2479                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2480
2481                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2482                 // Verify broadcast of revoked HTLC-timeout
2483                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2484                 check_added_monitors!(nodes[0], 1);
2485                 // Broadcast revoked HTLC-timeout on node 1
2486                 mine_transaction(&nodes[1], &node_txn[1]);
2487                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2488         }
2489         get_announce_close_broadcast_events(&nodes, 0, 1);
2490
2491         assert_eq!(nodes[0].node.list_channels().len(), 0);
2492         assert_eq!(nodes[1].node.list_channels().len(), 0);
2493
2494         // We test justice_tx build by A on B's revoked HTLC-Success tx
2495         // Create some new channels:
2496         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2497         {
2498                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2499                 node_txn.clear();
2500         }
2501
2502         // A pending HTLC which will be revoked:
2503         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2504         // Get the will-be-revoked local txn from B
2505         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2506         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2507         assert_eq!(revoked_local_txn[0].input.len(), 1);
2508         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2509         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2510         // Revoke the old state
2511         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2512         {
2513                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2514                 {
2515                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2516                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2517                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2518
2519                         check_spends!(node_txn[0], revoked_local_txn[0]);
2520                         node_txn.swap_remove(0);
2521                 }
2522                 check_added_monitors!(nodes[0], 1);
2523                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2524
2525                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2526                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2527                 check_added_monitors!(nodes[1], 1);
2528                 mine_transaction(&nodes[0], &node_txn[1]);
2529                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2530         }
2531         get_announce_close_broadcast_events(&nodes, 0, 1);
2532         assert_eq!(nodes[0].node.list_channels().len(), 0);
2533         assert_eq!(nodes[1].node.list_channels().len(), 0);
2534 }
2535
2536 #[test]
2537 fn revoked_output_claim() {
2538         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2539         // transaction is broadcast by its counterparty
2540         let chanmon_cfgs = create_chanmon_cfgs(2);
2541         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2542         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2543         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2544         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2545         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2546         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2547         assert_eq!(revoked_local_txn.len(), 1);
2548         // Only output is the full channel value back to nodes[0]:
2549         assert_eq!(revoked_local_txn[0].output.len(), 1);
2550         // Send a payment through, updating everyone's latest commitment txn
2551         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2552
2553         // Inform nodes[1] that nodes[0] broadcast a stale tx
2554         mine_transaction(&nodes[1], &revoked_local_txn[0]);
2555         check_added_monitors!(nodes[1], 1);
2556         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2557         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2558
2559         check_spends!(node_txn[0], revoked_local_txn[0]);
2560         check_spends!(node_txn[1], chan_1.3);
2561
2562         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2563         mine_transaction(&nodes[0], &revoked_local_txn[0]);
2564         get_announce_close_broadcast_events(&nodes, 0, 1);
2565         check_added_monitors!(nodes[0], 1)
2566 }
2567
2568 #[test]
2569 fn claim_htlc_outputs_shared_tx() {
2570         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2571         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2572         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2573         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2574         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2575         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2576
2577         // Create some new channel:
2578         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2579
2580         // Rebalance the network to generate htlc in the two directions
2581         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2582         // 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
2583         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2584         let (_payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2585
2586         // Get the will-be-revoked local txn from node[0]
2587         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2588         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2589         assert_eq!(revoked_local_txn[0].input.len(), 1);
2590         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2591         assert_eq!(revoked_local_txn[1].input.len(), 1);
2592         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2593         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2594         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2595
2596         //Revoke the old state
2597         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2598
2599         {
2600                 mine_transaction(&nodes[0], &revoked_local_txn[0]);
2601                 check_added_monitors!(nodes[0], 1);
2602                 mine_transaction(&nodes[1], &revoked_local_txn[0]);
2603                 check_added_monitors!(nodes[1], 1);
2604                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2605                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2606
2607                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2608                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2609
2610                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2611                 check_spends!(node_txn[0], revoked_local_txn[0]);
2612
2613                 let mut witness_lens = BTreeSet::new();
2614                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2615                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2616                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2617                 assert_eq!(witness_lens.len(), 3);
2618                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2619                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2620                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2621
2622                 // Next nodes[1] broadcasts its current local tx state:
2623                 assert_eq!(node_txn[1].input.len(), 1);
2624                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2625
2626                 assert_eq!(node_txn[2].input.len(), 1);
2627                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2628                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2629                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2630                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2631                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2632         }
2633         get_announce_close_broadcast_events(&nodes, 0, 1);
2634         assert_eq!(nodes[0].node.list_channels().len(), 0);
2635         assert_eq!(nodes[1].node.list_channels().len(), 0);
2636 }
2637
2638 #[test]
2639 fn claim_htlc_outputs_single_tx() {
2640         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2641         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2642         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
2643         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2644         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2645         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2646
2647         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2648
2649         // Rebalance the network to generate htlc in the two directions
2650         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2651         // 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
2652         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2653         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2654         let (_payment_preimage_2, payment_hash_2, _payment_secret_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2655
2656         // Get the will-be-revoked local txn from node[0]
2657         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2658
2659         //Revoke the old state
2660         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2661
2662         {
2663                 confirm_transaction_at(&nodes[0], &revoked_local_txn[0], 100);
2664                 check_added_monitors!(nodes[0], 1);
2665                 confirm_transaction_at(&nodes[1], &revoked_local_txn[0], 100);
2666                 check_added_monitors!(nodes[1], 1);
2667                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2668
2669                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2670                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2671
2672                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2673                 assert_eq!(node_txn.len(), 9);
2674                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2675                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2676                 // 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)
2677                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2678
2679                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2680                 assert_eq!(node_txn[0].input.len(), 1);
2681                 check_spends!(node_txn[0], chan_1.3);
2682                 assert_eq!(node_txn[1].input.len(), 1);
2683                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2684                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2685                 check_spends!(node_txn[1], node_txn[0]);
2686
2687                 // Justice transactions are indices 1-2-4
2688                 assert_eq!(node_txn[2].input.len(), 1);
2689                 assert_eq!(node_txn[3].input.len(), 1);
2690                 assert_eq!(node_txn[4].input.len(), 1);
2691
2692                 check_spends!(node_txn[2], revoked_local_txn[0]);
2693                 check_spends!(node_txn[3], revoked_local_txn[0]);
2694                 check_spends!(node_txn[4], revoked_local_txn[0]);
2695
2696                 let mut witness_lens = BTreeSet::new();
2697                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2698                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2699                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2700                 assert_eq!(witness_lens.len(), 3);
2701                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2702                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2703                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2704         }
2705         get_announce_close_broadcast_events(&nodes, 0, 1);
2706         assert_eq!(nodes[0].node.list_channels().len(), 0);
2707         assert_eq!(nodes[1].node.list_channels().len(), 0);
2708 }
2709
2710 #[test]
2711 fn test_htlc_on_chain_success() {
2712         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2713         // the preimage backward accordingly. So here we test that ChannelManager is
2714         // broadcasting the right event to other nodes in payment path.
2715         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2716         // A --------------------> B ----------------------> C (preimage)
2717         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2718         // commitment transaction was broadcast.
2719         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2720         // towards B.
2721         // B should be able to claim via preimage if A then broadcasts its local tx.
2722         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2723         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2724         // PaymentSent event).
2725
2726         let chanmon_cfgs = create_chanmon_cfgs(3);
2727         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2728         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2729         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2730
2731         // Create some initial channels
2732         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2733         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2734
2735         // Rebalance the network a bit by relaying one payment through all the channels...
2736         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2737         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2738
2739         let (our_payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2740         let (our_payment_preimage_2, _payment_hash_2, _payment_secret_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2741
2742         // Broadcast legit commitment tx from C on B's chain
2743         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2744         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2745         assert_eq!(commitment_tx.len(), 1);
2746         check_spends!(commitment_tx[0], chan_2.3);
2747         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2748         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2749         check_added_monitors!(nodes[2], 2);
2750         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2751         assert!(updates.update_add_htlcs.is_empty());
2752         assert!(updates.update_fail_htlcs.is_empty());
2753         assert!(updates.update_fail_malformed_htlcs.is_empty());
2754         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2755
2756         mine_transaction(&nodes[2], &commitment_tx[0]);
2757         check_closed_broadcast!(nodes[2], true);
2758         check_added_monitors!(nodes[2], 1);
2759         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)
2760         assert_eq!(node_txn.len(), 5);
2761         assert_eq!(node_txn[0], node_txn[3]);
2762         assert_eq!(node_txn[1], node_txn[4]);
2763         assert_eq!(node_txn[2], commitment_tx[0]);
2764         check_spends!(node_txn[0], commitment_tx[0]);
2765         check_spends!(node_txn[1], commitment_tx[0]);
2766         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2767         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2768         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2769         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2770         assert_eq!(node_txn[0].lock_time, 0);
2771         assert_eq!(node_txn[1].lock_time, 0);
2772
2773         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2774         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2775         connect_block(&nodes[1], &Block { header, txdata: node_txn});
2776         {
2777                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2778                 assert_eq!(added_monitors.len(), 1);
2779                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2780                 added_monitors.clear();
2781         }
2782         let events = nodes[1].node.get_and_clear_pending_msg_events();
2783         {
2784                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2785                 assert_eq!(added_monitors.len(), 2);
2786                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2787                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2788                 added_monitors.clear();
2789         }
2790         assert_eq!(events.len(), 3);
2791         match events[0] {
2792                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2793                 _ => panic!("Unexpected event"),
2794         }
2795         match events[1] {
2796                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
2797                 _ => panic!("Unexpected event"),
2798         }
2799
2800         match events[2] {
2801                 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, .. } } => {
2802                         assert!(update_add_htlcs.is_empty());
2803                         assert!(update_fail_htlcs.is_empty());
2804                         assert_eq!(update_fulfill_htlcs.len(), 1);
2805                         assert!(update_fail_malformed_htlcs.is_empty());
2806                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2807                 },
2808                 _ => panic!("Unexpected event"),
2809         };
2810         macro_rules! check_tx_local_broadcast {
2811                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2812                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2813                         assert_eq!(node_txn.len(), 5);
2814                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2815                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2816                         check_spends!(node_txn[0], $commitment_tx);
2817                         check_spends!(node_txn[1], $commitment_tx);
2818                         assert_ne!(node_txn[0].lock_time, 0);
2819                         assert_ne!(node_txn[1].lock_time, 0);
2820                         if $htlc_offered {
2821                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2822                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2823                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2824                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2825                         } else {
2826                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2827                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2828                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2829                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2830                         }
2831                         check_spends!(node_txn[2], $chan_tx);
2832                         check_spends!(node_txn[3], node_txn[2]);
2833                         check_spends!(node_txn[4], node_txn[2]);
2834                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2835                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2836                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2837                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2838                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2839                         assert_ne!(node_txn[3].lock_time, 0);
2840                         assert_ne!(node_txn[4].lock_time, 0);
2841                         node_txn.clear();
2842                 } }
2843         }
2844         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2845         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2846         // timeout-claim of the output that nodes[2] just claimed via success.
2847         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2848
2849         // Broadcast legit commitment tx from A on B's chain
2850         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2851         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2852         check_spends!(commitment_tx[0], chan_1.3);
2853         mine_transaction(&nodes[1], &commitment_tx[0]);
2854         check_closed_broadcast!(nodes[1], true);
2855         check_added_monitors!(nodes[1], 1);
2856         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2857         assert_eq!(node_txn.len(), 4);
2858         check_spends!(node_txn[0], commitment_tx[0]);
2859         assert_eq!(node_txn[0].input.len(), 2);
2860         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2861         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2862         assert_eq!(node_txn[0].lock_time, 0);
2863         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2864         check_spends!(node_txn[1], chan_1.3);
2865         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2866         check_spends!(node_txn[2], node_txn[1]);
2867         check_spends!(node_txn[3], node_txn[1]);
2868         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2869         // we already checked the same situation with A.
2870
2871         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2872         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2873         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] });
2874         check_closed_broadcast!(nodes[0], true);
2875         check_added_monitors!(nodes[0], 1);
2876         let events = nodes[0].node.get_and_clear_pending_events();
2877         assert_eq!(events.len(), 2);
2878         let mut first_claimed = false;
2879         for event in events {
2880                 match event {
2881                         Event::PaymentSent { payment_preimage } => {
2882                                 if payment_preimage == our_payment_preimage {
2883                                         assert!(!first_claimed);
2884                                         first_claimed = true;
2885                                 } else {
2886                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2887                                 }
2888                         },
2889                         _ => panic!("Unexpected event"),
2890                 }
2891         }
2892         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2893 }
2894
2895 fn do_test_htlc_on_chain_timeout(connect_style: ConnectStyle) {
2896         // Test that in case of a unilateral close onchain, we detect the state of output and
2897         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2898         // broadcasting the right event to other nodes in payment path.
2899         // A ------------------> B ----------------------> C (timeout)
2900         //    B's commitment tx                 C's commitment tx
2901         //            \                                  \
2902         //         B's HTLC timeout tx               B's timeout tx
2903
2904         let chanmon_cfgs = create_chanmon_cfgs(3);
2905         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2906         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2907         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2908         *nodes[0].connect_style.borrow_mut() = connect_style;
2909         *nodes[1].connect_style.borrow_mut() = connect_style;
2910         *nodes[2].connect_style.borrow_mut() = connect_style;
2911
2912         // Create some intial channels
2913         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2914         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2915
2916         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2917         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2918         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2919
2920         let (_payment_preimage, payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2921
2922         // Broadcast legit commitment tx from C on B's chain
2923         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2924         check_spends!(commitment_tx[0], chan_2.3);
2925         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2926         check_added_monitors!(nodes[2], 0);
2927         expect_pending_htlcs_forwardable!(nodes[2]);
2928         check_added_monitors!(nodes[2], 1);
2929
2930         let events = nodes[2].node.get_and_clear_pending_msg_events();
2931         assert_eq!(events.len(), 1);
2932         match events[0] {
2933                 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, .. } } => {
2934                         assert!(update_add_htlcs.is_empty());
2935                         assert!(!update_fail_htlcs.is_empty());
2936                         assert!(update_fulfill_htlcs.is_empty());
2937                         assert!(update_fail_malformed_htlcs.is_empty());
2938                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2939                 },
2940                 _ => panic!("Unexpected event"),
2941         };
2942         mine_transaction(&nodes[2], &commitment_tx[0]);
2943         check_closed_broadcast!(nodes[2], true);
2944         check_added_monitors!(nodes[2], 1);
2945         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2946         assert_eq!(node_txn.len(), 1);
2947         check_spends!(node_txn[0], chan_2.3);
2948         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2949
2950         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2951         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2952         connect_blocks(&nodes[1], 200 - nodes[2].best_block_info().1);
2953         mine_transaction(&nodes[1], &commitment_tx[0]);
2954         let timeout_tx;
2955         {
2956                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2957                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2958                 assert_eq!(node_txn[0], node_txn[3]);
2959                 assert_eq!(node_txn[1], node_txn[4]);
2960
2961                 check_spends!(node_txn[2], commitment_tx[0]);
2962                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2963
2964                 check_spends!(node_txn[0], chan_2.3);
2965                 check_spends!(node_txn[1], node_txn[0]);
2966                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2967                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2968
2969                 timeout_tx = node_txn[2].clone();
2970                 node_txn.clear();
2971         }
2972
2973         mine_transaction(&nodes[1], &timeout_tx);
2974         check_added_monitors!(nodes[1], 1);
2975         check_closed_broadcast!(nodes[1], true);
2976         {
2977                 // B will rebroadcast a fee-bumped timeout transaction here.
2978                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2979                 assert_eq!(node_txn.len(), 1);
2980                 check_spends!(node_txn[0], commitment_tx[0]);
2981         }
2982
2983         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2984         {
2985                 // B will rebroadcast its own holder commitment transaction here...just because
2986                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2987                 assert_eq!(node_txn.len(), 1);
2988                 check_spends!(node_txn[0], chan_2.3);
2989         }
2990
2991         expect_pending_htlcs_forwardable!(nodes[1]);
2992         check_added_monitors!(nodes[1], 1);
2993         let events = nodes[1].node.get_and_clear_pending_msg_events();
2994         assert_eq!(events.len(), 1);
2995         match events[0] {
2996                 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, .. } } => {
2997                         assert!(update_add_htlcs.is_empty());
2998                         assert!(!update_fail_htlcs.is_empty());
2999                         assert!(update_fulfill_htlcs.is_empty());
3000                         assert!(update_fail_malformed_htlcs.is_empty());
3001                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3002                 },
3003                 _ => panic!("Unexpected event"),
3004         };
3005
3006         // Broadcast legit commitment tx from B on A's chain
3007         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3008         check_spends!(commitment_tx[0], chan_1.3);
3009
3010         mine_transaction(&nodes[0], &commitment_tx[0]);
3011
3012         check_closed_broadcast!(nodes[0], true);
3013         check_added_monitors!(nodes[0], 1);
3014         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3015         assert_eq!(node_txn.len(), 3);
3016         check_spends!(node_txn[0], commitment_tx[0]);
3017         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3018         check_spends!(node_txn[1], chan_1.3);
3019         check_spends!(node_txn[2], node_txn[1]);
3020         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3021         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3022 }
3023
3024 #[test]
3025 fn test_htlc_on_chain_timeout() {
3026         do_test_htlc_on_chain_timeout(ConnectStyle::BestBlockFirstSkippingBlocks);
3027         do_test_htlc_on_chain_timeout(ConnectStyle::TransactionsFirstSkippingBlocks);
3028         do_test_htlc_on_chain_timeout(ConnectStyle::FullBlockViaListen);
3029 }
3030
3031 #[test]
3032 fn test_simple_commitment_revoked_fail_backward() {
3033         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3034         // and fail backward accordingly.
3035
3036         let chanmon_cfgs = create_chanmon_cfgs(3);
3037         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3038         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3039         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3040
3041         // Create some initial channels
3042         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3043         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3044
3045         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3046         // Get the will-be-revoked local txn from nodes[2]
3047         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3048         // Revoke the old state
3049         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3050
3051         let (_, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3052
3053         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3054         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3055         check_added_monitors!(nodes[1], 1);
3056         check_closed_broadcast!(nodes[1], true);
3057
3058         expect_pending_htlcs_forwardable!(nodes[1]);
3059         check_added_monitors!(nodes[1], 1);
3060         let events = nodes[1].node.get_and_clear_pending_msg_events();
3061         assert_eq!(events.len(), 1);
3062         match events[0] {
3063                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed, .. } } => {
3064                         assert!(update_add_htlcs.is_empty());
3065                         assert_eq!(update_fail_htlcs.len(), 1);
3066                         assert!(update_fulfill_htlcs.is_empty());
3067                         assert!(update_fail_malformed_htlcs.is_empty());
3068                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3069
3070                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3071                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3072
3073                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3074                         assert_eq!(events.len(), 1);
3075                         match events[0] {
3076                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3077                                 _ => panic!("Unexpected event"),
3078                         }
3079                         expect_payment_failed!(nodes[0], payment_hash, false);
3080                 },
3081                 _ => panic!("Unexpected event"),
3082         }
3083 }
3084
3085 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3086         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3087         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3088         // commitment transaction anymore.
3089         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3090         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3091         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3092         // technically disallowed and we should probably handle it reasonably.
3093         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3094         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3095         // transactions:
3096         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3097         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3098         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3099         //   and once they revoke the previous commitment transaction (allowing us to send a new
3100         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3101         let chanmon_cfgs = create_chanmon_cfgs(3);
3102         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3103         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3104         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3105
3106         // Create some initial channels
3107         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3108         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3109
3110         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 });
3111         // Get the will-be-revoked local txn from nodes[2]
3112         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3113         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3114         // Revoke the old state
3115         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3116
3117         let value = if use_dust {
3118                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3119                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3120                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3121         } else { 3000000 };
3122
3123         let (_, first_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3124         let (_, second_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3125         let (_, third_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3126
3127         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3128         expect_pending_htlcs_forwardable!(nodes[2]);
3129         check_added_monitors!(nodes[2], 1);
3130         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3131         assert!(updates.update_add_htlcs.is_empty());
3132         assert!(updates.update_fulfill_htlcs.is_empty());
3133         assert!(updates.update_fail_malformed_htlcs.is_empty());
3134         assert_eq!(updates.update_fail_htlcs.len(), 1);
3135         assert!(updates.update_fee.is_none());
3136         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3137         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3138         // Drop the last RAA from 3 -> 2
3139
3140         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3141         expect_pending_htlcs_forwardable!(nodes[2]);
3142         check_added_monitors!(nodes[2], 1);
3143         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3144         assert!(updates.update_add_htlcs.is_empty());
3145         assert!(updates.update_fulfill_htlcs.is_empty());
3146         assert!(updates.update_fail_malformed_htlcs.is_empty());
3147         assert_eq!(updates.update_fail_htlcs.len(), 1);
3148         assert!(updates.update_fee.is_none());
3149         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3150         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3151         check_added_monitors!(nodes[1], 1);
3152         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3153         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3154         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3155         check_added_monitors!(nodes[2], 1);
3156
3157         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3158         expect_pending_htlcs_forwardable!(nodes[2]);
3159         check_added_monitors!(nodes[2], 1);
3160         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3161         assert!(updates.update_add_htlcs.is_empty());
3162         assert!(updates.update_fulfill_htlcs.is_empty());
3163         assert!(updates.update_fail_malformed_htlcs.is_empty());
3164         assert_eq!(updates.update_fail_htlcs.len(), 1);
3165         assert!(updates.update_fee.is_none());
3166         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3167         // At this point first_payment_hash has dropped out of the latest two commitment
3168         // transactions that nodes[1] is tracking...
3169         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3170         check_added_monitors!(nodes[1], 1);
3171         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3172         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3173         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3174         check_added_monitors!(nodes[2], 1);
3175
3176         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3177         // on nodes[2]'s RAA.
3178         let (_, fourth_payment_hash, fourth_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3179         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3180         let logger = test_utils::TestLogger::new();
3181         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();
3182         nodes[1].node.send_payment(&route, fourth_payment_hash, &Some(fourth_payment_secret)).unwrap();
3183         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3184         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3185         check_added_monitors!(nodes[1], 0);
3186
3187         if deliver_bs_raa {
3188                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3189                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3190                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3191                 check_added_monitors!(nodes[1], 1);
3192                 let events = nodes[1].node.get_and_clear_pending_events();
3193                 assert_eq!(events.len(), 1);
3194                 match events[0] {
3195                         Event::PendingHTLCsForwardable { .. } => { },
3196                         _ => panic!("Unexpected event"),
3197                 };
3198                 // Deliberately don't process the pending fail-back so they all fail back at once after
3199                 // block connection just like the !deliver_bs_raa case
3200         }
3201
3202         let mut failed_htlcs = HashSet::new();
3203         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3204
3205         mine_transaction(&nodes[1], &revoked_local_txn[0]);
3206         check_added_monitors!(nodes[1], 1);
3207         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
3208
3209         let events = nodes[1].node.get_and_clear_pending_events();
3210         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3211         match events[0] {
3212                 Event::PaymentFailed { ref payment_hash, .. } => {
3213                         assert_eq!(*payment_hash, fourth_payment_hash);
3214                 },
3215                 _ => panic!("Unexpected event"),
3216         }
3217         if !deliver_bs_raa {
3218                 match events[1] {
3219                         Event::PendingHTLCsForwardable { .. } => { },
3220                         _ => panic!("Unexpected event"),
3221                 };
3222         }
3223         nodes[1].node.process_pending_htlc_forwards();
3224         check_added_monitors!(nodes[1], 1);
3225
3226         let events = nodes[1].node.get_and_clear_pending_msg_events();
3227         assert_eq!(events.len(), if deliver_bs_raa { 4 } else { 3 });
3228         match events[if deliver_bs_raa { 1 } else { 0 }] {
3229                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3230                 _ => panic!("Unexpected event"),
3231         }
3232         match events[if deliver_bs_raa { 2 } else { 1 }] {
3233                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id, ref data } }, node_id: _ } => {
3234                         assert_eq!(channel_id, chan_2.2);
3235                         assert_eq!(data.as_str(), "Commitment or closing transaction was confirmed on chain.");
3236                 },
3237                 _ => panic!("Unexpected event"),
3238         }
3239         if deliver_bs_raa {
3240                 match events[0] {
3241                         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, .. } } => {
3242                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3243                                 assert_eq!(update_add_htlcs.len(), 1);
3244                                 assert!(update_fulfill_htlcs.is_empty());
3245                                 assert!(update_fail_htlcs.is_empty());
3246                                 assert!(update_fail_malformed_htlcs.is_empty());
3247                         },
3248                         _ => panic!("Unexpected event"),
3249                 }
3250         }
3251         match events[if deliver_bs_raa { 3 } else { 2 }] {
3252                 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, .. } } => {
3253                         assert!(update_add_htlcs.is_empty());
3254                         assert_eq!(update_fail_htlcs.len(), 3);
3255                         assert!(update_fulfill_htlcs.is_empty());
3256                         assert!(update_fail_malformed_htlcs.is_empty());
3257                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3258
3259                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3260                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3261                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3262
3263                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3264
3265                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3266                         // If we delivered B's RAA we got an unknown preimage error, not something
3267                         // that we should update our routing table for.
3268                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3269                         for event in events {
3270                                 match event {
3271                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3272                                         _ => panic!("Unexpected event"),
3273                                 }
3274                         }
3275                         let events = nodes[0].node.get_and_clear_pending_events();
3276                         assert_eq!(events.len(), 3);
3277                         match events[0] {
3278                                 Event::PaymentFailed { ref payment_hash, .. } => {
3279                                         assert!(failed_htlcs.insert(payment_hash.0));
3280                                 },
3281                                 _ => panic!("Unexpected event"),
3282                         }
3283                         match events[1] {
3284                                 Event::PaymentFailed { ref payment_hash, .. } => {
3285                                         assert!(failed_htlcs.insert(payment_hash.0));
3286                                 },
3287                                 _ => panic!("Unexpected event"),
3288                         }
3289                         match events[2] {
3290                                 Event::PaymentFailed { ref payment_hash, .. } => {
3291                                         assert!(failed_htlcs.insert(payment_hash.0));
3292                                 },
3293                                 _ => panic!("Unexpected event"),
3294                         }
3295                 },
3296                 _ => panic!("Unexpected event"),
3297         }
3298
3299         assert!(failed_htlcs.contains(&first_payment_hash.0));
3300         assert!(failed_htlcs.contains(&second_payment_hash.0));
3301         assert!(failed_htlcs.contains(&third_payment_hash.0));
3302 }
3303
3304 #[test]
3305 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3306         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3307         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3308         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3309         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3310 }
3311
3312 #[test]
3313 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3314         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3315         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3316         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3317         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3318 }
3319
3320 #[test]
3321 fn fail_backward_pending_htlc_upon_channel_failure() {
3322         let chanmon_cfgs = create_chanmon_cfgs(2);
3323         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3324         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3325         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3326         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3327         let logger = test_utils::TestLogger::new();
3328
3329         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3330         {
3331                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
3332                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3333                 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();
3334                 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
3335                 check_added_monitors!(nodes[0], 1);
3336
3337                 let payment_event = {
3338                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3339                         assert_eq!(events.len(), 1);
3340                         SendEvent::from_event(events.remove(0))
3341                 };
3342                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3343                 assert_eq!(payment_event.msgs.len(), 1);
3344         }
3345
3346         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3347         let (_, failed_payment_hash, failed_payment_secret) = get_payment_preimage_hash!(nodes[1]);
3348         {
3349                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3350                 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();
3351                 nodes[0].node.send_payment(&route, failed_payment_hash, &Some(failed_payment_secret)).unwrap();
3352                 check_added_monitors!(nodes[0], 0);
3353
3354                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3355         }
3356
3357         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3358         {
3359                 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
3360
3361                 let secp_ctx = Secp256k1::new();
3362                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3363                 let current_height = nodes[1].node.best_block.read().unwrap().height() + 1;
3364                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3365                 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();
3366                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &Some(payment_secret), current_height).unwrap();
3367                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3368                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3369
3370                 // Send a 0-msat update_add_htlc to fail the channel.
3371                 let update_add_htlc = msgs::UpdateAddHTLC {
3372                         channel_id: chan.2,
3373                         htlc_id: 0,
3374                         amount_msat: 0,
3375                         payment_hash,
3376                         cltv_expiry,
3377                         onion_routing_packet,
3378                 };
3379                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3380         }
3381
3382         // Check that Alice fails backward the pending HTLC from the second payment.
3383         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3384         check_closed_broadcast!(nodes[0], true);
3385         check_added_monitors!(nodes[0], 1);
3386 }
3387
3388 #[test]
3389 fn test_htlc_ignore_latest_remote_commitment() {
3390         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3391         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3392         let chanmon_cfgs = create_chanmon_cfgs(2);
3393         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3394         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3395         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3396         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3397
3398         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3399         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
3400         check_closed_broadcast!(nodes[0], true);
3401         check_added_monitors!(nodes[0], 1);
3402
3403         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3404         assert_eq!(node_txn.len(), 2);
3405
3406         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3407         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3408         check_closed_broadcast!(nodes[1], true);
3409         check_added_monitors!(nodes[1], 1);
3410
3411         // Duplicate the connect_block call since this may happen due to other listeners
3412         // registering new transactions
3413         header.prev_blockhash = header.block_hash();
3414         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]});
3415 }
3416
3417 #[test]
3418 fn test_force_close_fail_back() {
3419         // Check which HTLCs are failed-backwards on channel force-closure
3420         let chanmon_cfgs = create_chanmon_cfgs(3);
3421         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3422         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3423         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3424         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3425         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3426         let logger = test_utils::TestLogger::new();
3427
3428         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
3429
3430         let mut payment_event = {
3431                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3432                 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();
3433                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
3434                 check_added_monitors!(nodes[0], 1);
3435
3436                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3437                 assert_eq!(events.len(), 1);
3438                 SendEvent::from_event(events.remove(0))
3439         };
3440
3441         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3442         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3443
3444         expect_pending_htlcs_forwardable!(nodes[1]);
3445
3446         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3447         assert_eq!(events_2.len(), 1);
3448         payment_event = SendEvent::from_event(events_2.remove(0));
3449         assert_eq!(payment_event.msgs.len(), 1);
3450
3451         check_added_monitors!(nodes[1], 1);
3452         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3453         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3454         check_added_monitors!(nodes[2], 1);
3455         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3456
3457         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3458         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3459         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3460
3461         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id).unwrap();
3462         check_closed_broadcast!(nodes[2], true);
3463         check_added_monitors!(nodes[2], 1);
3464         let tx = {
3465                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3466                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3467                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3468                 // back to nodes[1] upon timeout otherwise.
3469                 assert_eq!(node_txn.len(), 1);
3470                 node_txn.remove(0)
3471         };
3472
3473         mine_transaction(&nodes[1], &tx);
3474
3475         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3476         check_closed_broadcast!(nodes[1], true);
3477         check_added_monitors!(nodes[1], 1);
3478
3479         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3480         {
3481                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.read().unwrap();
3482                 monitors.get(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3483                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage, &node_cfgs[2].tx_broadcaster, &node_cfgs[2].fee_estimator, &&logger);
3484         }
3485         mine_transaction(&nodes[2], &tx);
3486         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3487         assert_eq!(node_txn.len(), 1);
3488         assert_eq!(node_txn[0].input.len(), 1);
3489         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3490         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3491         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3492
3493         check_spends!(node_txn[0], tx);
3494 }
3495
3496 #[test]
3497 fn test_simple_peer_disconnect() {
3498         // Test that we can reconnect when there are no lost messages
3499         let chanmon_cfgs = create_chanmon_cfgs(3);
3500         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3501         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3502         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3503         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3504         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3505
3506         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3507         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3508         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3509
3510         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3511         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3512         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3513         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3514
3515         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3516         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3517         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3518
3519         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3520         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3521         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3522         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3523
3524         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3525         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3526
3527         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], true, payment_preimage_3, 1_000_000);
3528         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3529
3530         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3531         {
3532                 let events = nodes[0].node.get_and_clear_pending_events();
3533                 assert_eq!(events.len(), 2);
3534                 match events[0] {
3535                         Event::PaymentSent { payment_preimage } => {
3536                                 assert_eq!(payment_preimage, payment_preimage_3);
3537                         },
3538                         _ => panic!("Unexpected event"),
3539                 }
3540                 match events[1] {
3541                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3542                                 assert_eq!(payment_hash, payment_hash_5);
3543                                 assert!(rejected_by_dest);
3544                         },
3545                         _ => panic!("Unexpected event"),
3546                 }
3547         }
3548
3549         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3550         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3551 }
3552
3553 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3554         // Test that we can reconnect when in-flight HTLC updates get dropped
3555         let chanmon_cfgs = create_chanmon_cfgs(2);
3556         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3557         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3558         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3559         if messages_delivered == 0 {
3560                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3561                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3562         } else {
3563                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3564         }
3565
3566         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
3567
3568         let logger = test_utils::TestLogger::new();
3569         let payment_event = {
3570                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3571                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3572                         &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3573                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3574                 nodes[0].node.send_payment(&route, payment_hash_1, &Some(payment_secret_1)).unwrap();
3575                 check_added_monitors!(nodes[0], 1);
3576
3577                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3578                 assert_eq!(events.len(), 1);
3579                 SendEvent::from_event(events.remove(0))
3580         };
3581         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3582
3583         if messages_delivered < 2 {
3584                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3585         } else {
3586                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3587                 if messages_delivered >= 3 {
3588                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3589                         check_added_monitors!(nodes[1], 1);
3590                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3591
3592                         if messages_delivered >= 4 {
3593                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3594                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3595                                 check_added_monitors!(nodes[0], 1);
3596
3597                                 if messages_delivered >= 5 {
3598                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3599                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3600                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3601                                         check_added_monitors!(nodes[0], 1);
3602
3603                                         if messages_delivered >= 6 {
3604                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3605                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3606                                                 check_added_monitors!(nodes[1], 1);
3607                                         }
3608                                 }
3609                         }
3610                 }
3611         }
3612
3613         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3614         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3615         if messages_delivered < 3 {
3616                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3617                 // received on either side, both sides will need to resend them.
3618                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3619         } else if messages_delivered == 3 {
3620                 // nodes[0] still wants its RAA + commitment_signed
3621                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3622         } else if messages_delivered == 4 {
3623                 // nodes[0] still wants its commitment_signed
3624                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3625         } else if messages_delivered == 5 {
3626                 // nodes[1] still wants its final RAA
3627                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3628         } else if messages_delivered == 6 {
3629                 // Everything was delivered...
3630                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3631         }
3632
3633         let events_1 = nodes[1].node.get_and_clear_pending_events();
3634         assert_eq!(events_1.len(), 1);
3635         match events_1[0] {
3636                 Event::PendingHTLCsForwardable { .. } => { },
3637                 _ => panic!("Unexpected event"),
3638         };
3639
3640         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3641         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3642         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3643
3644         nodes[1].node.process_pending_htlc_forwards();
3645
3646         let events_2 = nodes[1].node.get_and_clear_pending_events();
3647         assert_eq!(events_2.len(), 1);
3648         match events_2[0] {
3649                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt, user_payment_id: _ } => {
3650                         assert_eq!(payment_hash_1, *payment_hash);
3651                         assert_eq!(Some(payment_secret_1), *payment_secret);
3652                         assert_eq!(amt, 1000000);
3653                 },
3654                 _ => panic!("Unexpected event"),
3655         }
3656
3657         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3658         check_added_monitors!(nodes[1], 1);
3659
3660         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3661         assert_eq!(events_3.len(), 1);
3662         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3663                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3664                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3665                         assert!(updates.update_add_htlcs.is_empty());
3666                         assert!(updates.update_fail_htlcs.is_empty());
3667                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3668                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3669                         assert!(updates.update_fee.is_none());
3670                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3671                 },
3672                 _ => panic!("Unexpected event"),
3673         };
3674
3675         if messages_delivered >= 1 {
3676                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3677
3678                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3679                 assert_eq!(events_4.len(), 1);
3680                 match events_4[0] {
3681                         Event::PaymentSent { ref payment_preimage } => {
3682                                 assert_eq!(payment_preimage_1, *payment_preimage);
3683                         },
3684                         _ => panic!("Unexpected event"),
3685                 }
3686
3687                 if messages_delivered >= 2 {
3688                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3689                         check_added_monitors!(nodes[0], 1);
3690                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3691
3692                         if messages_delivered >= 3 {
3693                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3694                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3695                                 check_added_monitors!(nodes[1], 1);
3696
3697                                 if messages_delivered >= 4 {
3698                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3699                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3700                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3701                                         check_added_monitors!(nodes[1], 1);
3702
3703                                         if messages_delivered >= 5 {
3704                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3705                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3706                                                 check_added_monitors!(nodes[0], 1);
3707                                         }
3708                                 }
3709                         }
3710                 }
3711         }
3712
3713         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3714         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3715         if messages_delivered < 2 {
3716                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3717                 //TODO: Deduplicate PaymentSent events, then enable this if:
3718                 //if messages_delivered < 1 {
3719                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3720                         assert_eq!(events_4.len(), 1);
3721                         match events_4[0] {
3722                                 Event::PaymentSent { ref payment_preimage } => {
3723                                         assert_eq!(payment_preimage_1, *payment_preimage);
3724                                 },
3725                                 _ => panic!("Unexpected event"),
3726                         }
3727                 //}
3728         } else if messages_delivered == 2 {
3729                 // nodes[0] still wants its RAA + commitment_signed
3730                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3731         } else if messages_delivered == 3 {
3732                 // nodes[0] still wants its commitment_signed
3733                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3734         } else if messages_delivered == 4 {
3735                 // nodes[1] still wants its final RAA
3736                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3737         } else if messages_delivered == 5 {
3738                 // Everything was delivered...
3739                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3740         }
3741
3742         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3743         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3744         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3745
3746         // Channel should still work fine...
3747         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3748         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3749                 &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3750                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3751         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3752         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3753 }
3754
3755 #[test]
3756 fn test_drop_messages_peer_disconnect_a() {
3757         do_test_drop_messages_peer_disconnect(0);
3758         do_test_drop_messages_peer_disconnect(1);
3759         do_test_drop_messages_peer_disconnect(2);
3760         do_test_drop_messages_peer_disconnect(3);
3761 }
3762
3763 #[test]
3764 fn test_drop_messages_peer_disconnect_b() {
3765         do_test_drop_messages_peer_disconnect(4);
3766         do_test_drop_messages_peer_disconnect(5);
3767         do_test_drop_messages_peer_disconnect(6);
3768 }
3769
3770 #[test]
3771 fn test_funding_peer_disconnect() {
3772         // Test that we can lock in our funding tx while disconnected
3773         let chanmon_cfgs = create_chanmon_cfgs(2);
3774         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3775         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3776         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3777         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3778
3779         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3780         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3781
3782         confirm_transaction(&nodes[0], &tx);
3783         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3784         assert_eq!(events_1.len(), 1);
3785         match events_1[0] {
3786                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3787                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3788                 },
3789                 _ => panic!("Unexpected event"),
3790         }
3791
3792         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3793
3794         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3795         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3796
3797         confirm_transaction(&nodes[1], &tx);
3798         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3799         assert_eq!(events_2.len(), 2);
3800         let funding_locked = match events_2[0] {
3801                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3802                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3803                         msg.clone()
3804                 },
3805                 _ => panic!("Unexpected event"),
3806         };
3807         let bs_announcement_sigs = match events_2[1] {
3808                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3809                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3810                         msg.clone()
3811                 },
3812                 _ => panic!("Unexpected event"),
3813         };
3814
3815         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3816
3817         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3818         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3819         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3820         assert_eq!(events_3.len(), 2);
3821         let as_announcement_sigs = match events_3[0] {
3822                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3823                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3824                         msg.clone()
3825                 },
3826                 _ => panic!("Unexpected event"),
3827         };
3828         let (as_announcement, as_update) = match events_3[1] {
3829                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3830                         (msg.clone(), update_msg.clone())
3831                 },
3832                 _ => panic!("Unexpected event"),
3833         };
3834
3835         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3836         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3837         assert_eq!(events_4.len(), 1);
3838         let (_, bs_update) = match events_4[0] {
3839                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3840                         (msg.clone(), update_msg.clone())
3841                 },
3842                 _ => panic!("Unexpected event"),
3843         };
3844
3845         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3846         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3847         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3848
3849         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3850         let logger = test_utils::TestLogger::new();
3851         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();
3852         let (payment_preimage, _, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3853         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3854 }
3855
3856 #[test]
3857 fn test_drop_messages_peer_disconnect_dual_htlc() {
3858         // Test that we can handle reconnecting when both sides of a channel have pending
3859         // commitment_updates when we disconnect.
3860         let chanmon_cfgs = create_chanmon_cfgs(2);
3861         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3862         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3863         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3864         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3865         let logger = test_utils::TestLogger::new();
3866
3867         let (payment_preimage_1, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3868
3869         // Now try to send a second payment which will fail to send
3870         let (payment_preimage_2, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
3871         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3872         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();
3873         nodes[0].node.send_payment(&route, payment_hash_2, &Some(payment_secret_2)).unwrap();
3874         check_added_monitors!(nodes[0], 1);
3875
3876         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3877         assert_eq!(events_1.len(), 1);
3878         match events_1[0] {
3879                 MessageSendEvent::UpdateHTLCs { .. } => {},
3880                 _ => panic!("Unexpected event"),
3881         }
3882
3883         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3884         check_added_monitors!(nodes[1], 1);
3885
3886         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3887         assert_eq!(events_2.len(), 1);
3888         match events_2[0] {
3889                 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 } } => {
3890                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3891                         assert!(update_add_htlcs.is_empty());
3892                         assert_eq!(update_fulfill_htlcs.len(), 1);
3893                         assert!(update_fail_htlcs.is_empty());
3894                         assert!(update_fail_malformed_htlcs.is_empty());
3895                         assert!(update_fee.is_none());
3896
3897                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3898                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3899                         assert_eq!(events_3.len(), 1);
3900                         match events_3[0] {
3901                                 Event::PaymentSent { ref payment_preimage } => {
3902                                         assert_eq!(*payment_preimage, payment_preimage_1);
3903                                 },
3904                                 _ => panic!("Unexpected event"),
3905                         }
3906
3907                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3908                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3909                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3910                         check_added_monitors!(nodes[0], 1);
3911                 },
3912                 _ => panic!("Unexpected event"),
3913         }
3914
3915         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3916         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3917
3918         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3919         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3920         assert_eq!(reestablish_1.len(), 1);
3921         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3922         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3923         assert_eq!(reestablish_2.len(), 1);
3924
3925         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3926         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3927         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3928         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3929
3930         assert!(as_resp.0.is_none());
3931         assert!(bs_resp.0.is_none());
3932
3933         assert!(bs_resp.1.is_none());
3934         assert!(bs_resp.2.is_none());
3935
3936         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3937
3938         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3939         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3940         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3941         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3942         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3943         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3944         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3945         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3946         // No commitment_signed so get_event_msg's assert(len == 1) passes
3947         check_added_monitors!(nodes[1], 1);
3948
3949         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3950         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3951         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3952         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3953         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3954         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3955         assert!(bs_second_commitment_signed.update_fee.is_none());
3956         check_added_monitors!(nodes[1], 1);
3957
3958         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3959         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3960         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3961         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3962         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3963         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3964         assert!(as_commitment_signed.update_fee.is_none());
3965         check_added_monitors!(nodes[0], 1);
3966
3967         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3968         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3969         // No commitment_signed so get_event_msg's assert(len == 1) passes
3970         check_added_monitors!(nodes[0], 1);
3971
3972         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3973         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3974         // No commitment_signed so get_event_msg's assert(len == 1) passes
3975         check_added_monitors!(nodes[1], 1);
3976
3977         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3978         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3979         check_added_monitors!(nodes[1], 1);
3980
3981         expect_pending_htlcs_forwardable!(nodes[1]);
3982
3983         let events_5 = nodes[1].node.get_and_clear_pending_events();
3984         assert_eq!(events_5.len(), 1);
3985         match events_5[0] {
3986                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _, user_payment_id: _ } => {
3987                         assert_eq!(payment_hash_2, *payment_hash);
3988                         assert_eq!(Some(payment_secret_2), *payment_secret);
3989                 },
3990                 _ => panic!("Unexpected event"),
3991         }
3992
3993         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3994         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3995         check_added_monitors!(nodes[0], 1);
3996
3997         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3998 }
3999
4000 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4001         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4002         // to avoid our counterparty failing the channel.
4003         let chanmon_cfgs = create_chanmon_cfgs(2);
4004         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4005         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4006         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4007
4008         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4009         let logger = test_utils::TestLogger::new();
4010
4011         let our_payment_hash = if send_partial_mpp {
4012                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4013                 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();
4014                 let (_, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
4015                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4016                 // indicates there are more HTLCs coming.
4017                 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.
4018                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, cur_height).unwrap();
4019                 check_added_monitors!(nodes[0], 1);
4020                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4021                 assert_eq!(events.len(), 1);
4022                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4023                 // hop should *not* yet generate any PaymentReceived event(s).
4024                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, payment_secret, events.drain(..).next().unwrap(), false);
4025                 our_payment_hash
4026         } else {
4027                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4028         };
4029
4030         let mut block = Block {
4031                 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4032                 txdata: vec![],
4033         };
4034         connect_block(&nodes[0], &block);
4035         connect_block(&nodes[1], &block);
4036         for _ in CHAN_CONFIRM_DEPTH + 2 ..TEST_FINAL_CLTV + CHAN_CONFIRM_DEPTH + 2 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4037                 block.header.prev_blockhash = block.block_hash();
4038                 connect_block(&nodes[0], &block);
4039                 connect_block(&nodes[1], &block);
4040         }
4041
4042         expect_pending_htlcs_forwardable!(nodes[1]);
4043
4044         check_added_monitors!(nodes[1], 1);
4045         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4046         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4047         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4048         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4049         assert!(htlc_timeout_updates.update_fee.is_none());
4050
4051         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4052         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4053         // 100_000 msat as u64, followed by a height of TEST_FINAL_CLTV + 2 as u32
4054         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4055         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(TEST_FINAL_CLTV + 2));
4056         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4057 }
4058
4059 #[test]
4060 fn test_htlc_timeout() {
4061         do_test_htlc_timeout(true);
4062         do_test_htlc_timeout(false);
4063 }
4064
4065 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4066         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4067         let chanmon_cfgs = create_chanmon_cfgs(3);
4068         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4069         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4070         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4071         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4072         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4073
4074         // Make sure all nodes are at the same starting height
4075         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
4076         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
4077         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
4078
4079         let logger = test_utils::TestLogger::new();
4080
4081         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4082         let (_, first_payment_hash, first_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4083         {
4084                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4085                 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();
4086                 nodes[1].node.send_payment(&route, first_payment_hash, &Some(first_payment_secret)).unwrap();
4087         }
4088         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4089         check_added_monitors!(nodes[1], 1);
4090
4091         // Now attempt to route a second payment, which should be placed in the holding cell
4092         let (_, second_payment_hash, second_payment_secret) = get_payment_preimage_hash!(nodes[2]);
4093         if forwarded_htlc {
4094                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4095                 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();
4096                 nodes[0].node.send_payment(&route, second_payment_hash, &Some(first_payment_secret)).unwrap();
4097                 check_added_monitors!(nodes[0], 1);
4098                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4099                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4100                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4101                 expect_pending_htlcs_forwardable!(nodes[1]);
4102                 check_added_monitors!(nodes[1], 0);
4103         } else {
4104                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4105                 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();
4106                 nodes[1].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)).unwrap();
4107                 check_added_monitors!(nodes[1], 0);
4108         }
4109
4110         connect_blocks(&nodes[1], TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4111         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4112         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4113         connect_blocks(&nodes[1], 1);
4114
4115         if forwarded_htlc {
4116                 expect_pending_htlcs_forwardable!(nodes[1]);
4117                 check_added_monitors!(nodes[1], 1);
4118                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4119                 assert_eq!(fail_commit.len(), 1);
4120                 match fail_commit[0] {
4121                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4122                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4123                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4124                         },
4125                         _ => unreachable!(),
4126                 }
4127                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4128                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4129                         match update {
4130                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4131                                 _ => panic!("Unexpected event"),
4132                         }
4133                 } else {
4134                         panic!("Unexpected event");
4135                 }
4136         } else {
4137                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4138         }
4139 }
4140
4141 #[test]
4142 fn test_holding_cell_htlc_add_timeouts() {
4143         do_test_holding_cell_htlc_add_timeouts(false);
4144         do_test_holding_cell_htlc_add_timeouts(true);
4145 }
4146
4147 #[test]
4148 fn test_invalid_channel_announcement() {
4149         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4150         let secp_ctx = Secp256k1::new();
4151         let chanmon_cfgs = create_chanmon_cfgs(2);
4152         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4153         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4154         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4155
4156         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4157
4158         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4159         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4160         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4161         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4162
4163         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 } );
4164
4165         let as_bitcoin_key = as_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4166         let bs_bitcoin_key = bs_chan.get_signer().inner.holder_channel_pubkeys.funding_pubkey;
4167
4168         let as_network_key = nodes[0].node.get_our_node_id();
4169         let bs_network_key = nodes[1].node.get_our_node_id();
4170
4171         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4172
4173         let mut chan_announcement;
4174
4175         macro_rules! dummy_unsigned_msg {
4176                 () => {
4177                         msgs::UnsignedChannelAnnouncement {
4178                                 features: ChannelFeatures::known(),
4179                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4180                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4181                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4182                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4183                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4184                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4185                                 excess_data: Vec::new(),
4186                         };
4187                 }
4188         }
4189
4190         macro_rules! sign_msg {
4191                 ($unsigned_msg: expr) => {
4192                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4193                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_signer().inner.funding_key);
4194                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_signer().inner.funding_key);
4195                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4196                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4197                         chan_announcement = msgs::ChannelAnnouncement {
4198                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4199                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4200                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4201                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4202                                 contents: $unsigned_msg
4203                         }
4204                 }
4205         }
4206
4207         let unsigned_msg = dummy_unsigned_msg!();
4208         sign_msg!(unsigned_msg);
4209         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4210         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 } );
4211
4212         // Configured with Network::Testnet
4213         let mut unsigned_msg = dummy_unsigned_msg!();
4214         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4215         sign_msg!(unsigned_msg);
4216         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4217
4218         let mut unsigned_msg = dummy_unsigned_msg!();
4219         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4220         sign_msg!(unsigned_msg);
4221         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4222 }
4223
4224 #[test]
4225 fn test_no_txn_manager_serialize_deserialize() {
4226         let chanmon_cfgs = create_chanmon_cfgs(2);
4227         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4228         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4229         let logger: test_utils::TestLogger;
4230         let fee_estimator: test_utils::TestFeeEstimator;
4231         let persister: test_utils::TestPersister;
4232         let new_chain_monitor: test_utils::TestChainMonitor;
4233         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4234         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4235
4236         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4237
4238         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4239
4240         let nodes_0_serialized = nodes[0].node.encode();
4241         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4242         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4243
4244         logger = test_utils::TestLogger::new();
4245         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4246         persister = test_utils::TestPersister::new();
4247         let keys_manager = &chanmon_cfgs[0].keys_manager;
4248         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4249         nodes[0].chain_monitor = &new_chain_monitor;
4250         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4251         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4252                 &mut chan_0_monitor_read, keys_manager).unwrap();
4253         assert!(chan_0_monitor_read.is_empty());
4254
4255         let mut nodes_0_read = &nodes_0_serialized[..];
4256         let config = UserConfig::default();
4257         let (_, nodes_0_deserialized_tmp) = {
4258                 let mut channel_monitors = HashMap::new();
4259                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4260                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4261                         default_config: config,
4262                         keys_manager,
4263                         fee_estimator: &fee_estimator,
4264                         chain_monitor: nodes[0].chain_monitor,
4265                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4266                         logger: &logger,
4267                         channel_monitors,
4268                 }).unwrap()
4269         };
4270         nodes_0_deserialized = nodes_0_deserialized_tmp;
4271         assert!(nodes_0_read.is_empty());
4272
4273         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4274         nodes[0].node = &nodes_0_deserialized;
4275         assert_eq!(nodes[0].node.list_channels().len(), 1);
4276         check_added_monitors!(nodes[0], 1);
4277
4278         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4279         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4280         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4281         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4282
4283         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4284         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4285         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4286         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4287
4288         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4289         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4290         for node in nodes.iter() {
4291                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4292                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4293                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4294         }
4295
4296         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4297 }
4298
4299 #[test]
4300 fn test_manager_serialize_deserialize_events() {
4301         // This test makes sure the events field in ChannelManager survives de/serialization
4302         let chanmon_cfgs = create_chanmon_cfgs(2);
4303         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4304         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4305         let fee_estimator: test_utils::TestFeeEstimator;
4306         let persister: test_utils::TestPersister;
4307         let logger: test_utils::TestLogger;
4308         let new_chain_monitor: test_utils::TestChainMonitor;
4309         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4310         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4311
4312         // Start creating a channel, but stop right before broadcasting the funding transaction
4313         let channel_value = 100000;
4314         let push_msat = 10001;
4315         let a_flags = InitFeatures::known();
4316         let b_flags = InitFeatures::known();
4317         let node_a = nodes.remove(0);
4318         let node_b = nodes.remove(0);
4319         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4320         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()));
4321         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()));
4322
4323         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4324
4325         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4326         check_added_monitors!(node_a, 0);
4327
4328         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()));
4329         {
4330                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4331                 assert_eq!(added_monitors.len(), 1);
4332                 assert_eq!(added_monitors[0].0, funding_output);
4333                 added_monitors.clear();
4334         }
4335
4336         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()));
4337         {
4338                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4339                 assert_eq!(added_monitors.len(), 1);
4340                 assert_eq!(added_monitors[0].0, funding_output);
4341                 added_monitors.clear();
4342         }
4343         // Normally, this is where node_a would broadcast the funding transaction, but the test de/serializes first instead
4344
4345         nodes.push(node_a);
4346         nodes.push(node_b);
4347
4348         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4349         let nodes_0_serialized = nodes[0].node.encode();
4350         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4351         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4352
4353         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4354         logger = test_utils::TestLogger::new();
4355         persister = test_utils::TestPersister::new();
4356         let keys_manager = &chanmon_cfgs[0].keys_manager;
4357         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4358         nodes[0].chain_monitor = &new_chain_monitor;
4359         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4360         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4361                 &mut chan_0_monitor_read, keys_manager).unwrap();
4362         assert!(chan_0_monitor_read.is_empty());
4363
4364         let mut nodes_0_read = &nodes_0_serialized[..];
4365         let config = UserConfig::default();
4366         let (_, nodes_0_deserialized_tmp) = {
4367                 let mut channel_monitors = HashMap::new();
4368                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4369                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4370                         default_config: config,
4371                         keys_manager,
4372                         fee_estimator: &fee_estimator,
4373                         chain_monitor: nodes[0].chain_monitor,
4374                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4375                         logger: &logger,
4376                         channel_monitors,
4377                 }).unwrap()
4378         };
4379         nodes_0_deserialized = nodes_0_deserialized_tmp;
4380         assert!(nodes_0_read.is_empty());
4381
4382         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4383
4384         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4385         nodes[0].node = &nodes_0_deserialized;
4386
4387         // After deserializing, make sure the funding_transaction is still held by the channel manager
4388         let events_4 = nodes[0].node.get_and_clear_pending_events();
4389         assert_eq!(events_4.len(), 0);
4390         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4391         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
4392
4393         // Make sure the channel is functioning as though the de/serialization never happened
4394         assert_eq!(nodes[0].node.list_channels().len(), 1);
4395         check_added_monitors!(nodes[0], 1);
4396
4397         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4398         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4399         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4400         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4401
4402         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4403         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4404         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4405         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4406
4407         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4408         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4409         for node in nodes.iter() {
4410                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4411                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4412                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4413         }
4414
4415         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4416 }
4417
4418 #[test]
4419 fn test_simple_manager_serialize_deserialize() {
4420         let chanmon_cfgs = create_chanmon_cfgs(2);
4421         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4422         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4423         let logger: test_utils::TestLogger;
4424         let fee_estimator: test_utils::TestFeeEstimator;
4425         let persister: test_utils::TestPersister;
4426         let new_chain_monitor: test_utils::TestChainMonitor;
4427         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4428         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4429         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4430
4431         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4432         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4433
4434         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4435
4436         let nodes_0_serialized = nodes[0].node.encode();
4437         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4438         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
4439
4440         logger = test_utils::TestLogger::new();
4441         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4442         persister = test_utils::TestPersister::new();
4443         let keys_manager = &chanmon_cfgs[0].keys_manager;
4444         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4445         nodes[0].chain_monitor = &new_chain_monitor;
4446         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4447         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4448                 &mut chan_0_monitor_read, keys_manager).unwrap();
4449         assert!(chan_0_monitor_read.is_empty());
4450
4451         let mut nodes_0_read = &nodes_0_serialized[..];
4452         let (_, nodes_0_deserialized_tmp) = {
4453                 let mut channel_monitors = HashMap::new();
4454                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4455                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4456                         default_config: UserConfig::default(),
4457                         keys_manager,
4458                         fee_estimator: &fee_estimator,
4459                         chain_monitor: nodes[0].chain_monitor,
4460                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4461                         logger: &logger,
4462                         channel_monitors,
4463                 }).unwrap()
4464         };
4465         nodes_0_deserialized = nodes_0_deserialized_tmp;
4466         assert!(nodes_0_read.is_empty());
4467
4468         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4469         nodes[0].node = &nodes_0_deserialized;
4470         check_added_monitors!(nodes[0], 1);
4471
4472         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4473
4474         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4475         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4476 }
4477
4478 #[test]
4479 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4480         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4481         let chanmon_cfgs = create_chanmon_cfgs(4);
4482         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4483         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4484         let logger: test_utils::TestLogger;
4485         let fee_estimator: test_utils::TestFeeEstimator;
4486         let persister: test_utils::TestPersister;
4487         let new_chain_monitor: test_utils::TestChainMonitor;
4488         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4489         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4490         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4491         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4492         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4493
4494         let mut node_0_stale_monitors_serialized = Vec::new();
4495         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4496                 let mut writer = test_utils::TestVecWriter(Vec::new());
4497                 monitor.1.write(&mut writer).unwrap();
4498                 node_0_stale_monitors_serialized.push(writer.0);
4499         }
4500
4501         let (our_payment_preimage, _, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4502
4503         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4504         let nodes_0_serialized = nodes[0].node.encode();
4505
4506         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4507         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4508         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4509         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4510
4511         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4512         // nodes[3])
4513         let mut node_0_monitors_serialized = Vec::new();
4514         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter() {
4515                 let mut writer = test_utils::TestVecWriter(Vec::new());
4516                 monitor.1.write(&mut writer).unwrap();
4517                 node_0_monitors_serialized.push(writer.0);
4518         }
4519
4520         logger = test_utils::TestLogger::new();
4521         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4522         persister = test_utils::TestPersister::new();
4523         let keys_manager = &chanmon_cfgs[0].keys_manager;
4524         new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator, &persister, keys_manager);
4525         nodes[0].chain_monitor = &new_chain_monitor;
4526
4527
4528         let mut node_0_stale_monitors = Vec::new();
4529         for serialized in node_0_stale_monitors_serialized.iter() {
4530                 let mut read = &serialized[..];
4531                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4532                 assert!(read.is_empty());
4533                 node_0_stale_monitors.push(monitor);
4534         }
4535
4536         let mut node_0_monitors = Vec::new();
4537         for serialized in node_0_monitors_serialized.iter() {
4538                 let mut read = &serialized[..];
4539                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut read, keys_manager).unwrap();
4540                 assert!(read.is_empty());
4541                 node_0_monitors.push(monitor);
4542         }
4543
4544         let mut nodes_0_read = &nodes_0_serialized[..];
4545         if let Err(msgs::DecodeError::InvalidValue) =
4546                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4547                 default_config: UserConfig::default(),
4548                 keys_manager,
4549                 fee_estimator: &fee_estimator,
4550                 chain_monitor: nodes[0].chain_monitor,
4551                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4552                 logger: &logger,
4553                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4554         }) { } else {
4555                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4556         };
4557
4558         let mut nodes_0_read = &nodes_0_serialized[..];
4559         let (_, nodes_0_deserialized_tmp) =
4560                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4561                 default_config: UserConfig::default(),
4562                 keys_manager,
4563                 fee_estimator: &fee_estimator,
4564                 chain_monitor: nodes[0].chain_monitor,
4565                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4566                 logger: &logger,
4567                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4568         }).unwrap();
4569         nodes_0_deserialized = nodes_0_deserialized_tmp;
4570         assert!(nodes_0_read.is_empty());
4571
4572         { // Channel close should result in a commitment tx and an HTLC tx
4573                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4574                 assert_eq!(txn.len(), 2);
4575                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4576                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4577         }
4578
4579         for monitor in node_0_monitors.drain(..) {
4580                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4581                 check_added_monitors!(nodes[0], 1);
4582         }
4583         nodes[0].node = &nodes_0_deserialized;
4584
4585         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4586         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4587         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4588         //... and we can even still claim the payment!
4589         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4590
4591         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4592         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4593         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4594         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4595         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4596         assert_eq!(msg_events.len(), 1);
4597         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4598                 match action {
4599                         &ErrorAction::SendErrorMessage { ref msg } => {
4600                                 assert_eq!(msg.channel_id, channel_id);
4601                         },
4602                         _ => panic!("Unexpected event!"),
4603                 }
4604         }
4605 }
4606
4607 macro_rules! check_spendable_outputs {
4608         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4609                 {
4610                         let mut events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4611                         let mut txn = Vec::new();
4612                         let mut all_outputs = Vec::new();
4613                         let secp_ctx = Secp256k1::new();
4614                         for event in events.drain(..) {
4615                                 match event {
4616                                         Event::SpendableOutputs { mut outputs } => {
4617                                                 for outp in outputs.drain(..) {
4618                                                         txn.push($keysinterface.backing.spend_spendable_outputs(&[&outp], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &secp_ctx).unwrap());
4619                                                         all_outputs.push(outp);
4620                                                 }
4621                                         },
4622                                         _ => panic!("Unexpected event"),
4623                                 };
4624                         }
4625                         if all_outputs.len() > 1 {
4626                                 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) {
4627                                         txn.push(tx);
4628                                 }
4629                         }
4630                         txn
4631                 }
4632         }
4633 }
4634
4635 #[test]
4636 fn test_claim_sizeable_push_msat() {
4637         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4638         let chanmon_cfgs = create_chanmon_cfgs(2);
4639         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4640         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4641         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4642
4643         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4644         nodes[1].node.force_close_channel(&chan.2).unwrap();
4645         check_closed_broadcast!(nodes[1], true);
4646         check_added_monitors!(nodes[1], 1);
4647         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4648         assert_eq!(node_txn.len(), 1);
4649         check_spends!(node_txn[0], chan.3);
4650         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
4651
4652         mine_transaction(&nodes[1], &node_txn[0]);
4653         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4654
4655         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4656         assert_eq!(spend_txn.len(), 1);
4657         check_spends!(spend_txn[0], node_txn[0]);
4658 }
4659
4660 #[test]
4661 fn test_claim_on_remote_sizeable_push_msat() {
4662         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4663         // to_remote output is encumbered by a P2WPKH
4664         let chanmon_cfgs = create_chanmon_cfgs(2);
4665         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4666         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4667         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4668
4669         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4670         nodes[0].node.force_close_channel(&chan.2).unwrap();
4671         check_closed_broadcast!(nodes[0], true);
4672         check_added_monitors!(nodes[0], 1);
4673
4674         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4675         assert_eq!(node_txn.len(), 1);
4676         check_spends!(node_txn[0], chan.3);
4677         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
4678
4679         mine_transaction(&nodes[1], &node_txn[0]);
4680         check_closed_broadcast!(nodes[1], true);
4681         check_added_monitors!(nodes[1], 1);
4682         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4683
4684         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4685         assert_eq!(spend_txn.len(), 1);
4686         check_spends!(spend_txn[0], node_txn[0]);
4687 }
4688
4689 #[test]
4690 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4691         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4692         // to_remote output is encumbered by a P2WPKH
4693
4694         let chanmon_cfgs = create_chanmon_cfgs(2);
4695         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4696         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4697         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4698
4699         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4700         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4701         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4702         assert_eq!(revoked_local_txn[0].input.len(), 1);
4703         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4704
4705         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4706         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4707         check_closed_broadcast!(nodes[1], true);
4708         check_added_monitors!(nodes[1], 1);
4709
4710         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4711         mine_transaction(&nodes[1], &node_txn[0]);
4712         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4713
4714         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4715         assert_eq!(spend_txn.len(), 3);
4716         check_spends!(spend_txn[0], revoked_local_txn[0]); // to_remote output on revoked remote commitment_tx
4717         check_spends!(spend_txn[1], node_txn[0]);
4718         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[0]); // Both outputs
4719 }
4720
4721 #[test]
4722 fn test_static_spendable_outputs_preimage_tx() {
4723         let chanmon_cfgs = create_chanmon_cfgs(2);
4724         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4725         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4726         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4727
4728         // Create some initial channels
4729         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4730
4731         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4732
4733         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4734         assert_eq!(commitment_tx[0].input.len(), 1);
4735         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4736
4737         // Settle A's commitment tx on B's chain
4738         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4739         check_added_monitors!(nodes[1], 1);
4740         mine_transaction(&nodes[1], &commitment_tx[0]);
4741         check_added_monitors!(nodes[1], 1);
4742         let events = nodes[1].node.get_and_clear_pending_msg_events();
4743         match events[0] {
4744                 MessageSendEvent::UpdateHTLCs { .. } => {},
4745                 _ => panic!("Unexpected event"),
4746         }
4747         match events[1] {
4748                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4749                 _ => panic!("Unexepected event"),
4750         }
4751
4752         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4753         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4754         assert_eq!(node_txn.len(), 3);
4755         check_spends!(node_txn[0], commitment_tx[0]);
4756         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4757         check_spends!(node_txn[1], chan_1.3);
4758         check_spends!(node_txn[2], node_txn[1]);
4759
4760         mine_transaction(&nodes[1], &node_txn[0]);
4761         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4762
4763         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4764         assert_eq!(spend_txn.len(), 1);
4765         check_spends!(spend_txn[0], node_txn[0]);
4766 }
4767
4768 #[test]
4769 fn test_static_spendable_outputs_timeout_tx() {
4770         let chanmon_cfgs = create_chanmon_cfgs(2);
4771         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4772         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4773         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4774
4775         // Create some initial channels
4776         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4777
4778         // Rebalance the network a bit by relaying one payment through all the channels ...
4779         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4780
4781         let (_, our_payment_hash, _) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4782
4783         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4784         assert_eq!(commitment_tx[0].input.len(), 1);
4785         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4786
4787         // Settle A's commitment tx on B' chain
4788         mine_transaction(&nodes[1], &commitment_tx[0]);
4789         check_added_monitors!(nodes[1], 1);
4790         let events = nodes[1].node.get_and_clear_pending_msg_events();
4791         match events[0] {
4792                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4793                 _ => panic!("Unexpected event"),
4794         }
4795
4796         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4797         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4798         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4799         check_spends!(node_txn[0],  commitment_tx[0].clone());
4800         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4801         check_spends!(node_txn[1], chan_1.3.clone());
4802         check_spends!(node_txn[2], node_txn[1]);
4803
4804         mine_transaction(&nodes[1], &node_txn[0]);
4805         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4806         expect_payment_failed!(nodes[1], our_payment_hash, true);
4807
4808         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4809         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote, timeout_tx.output
4810         check_spends!(spend_txn[0], commitment_tx[0]);
4811         check_spends!(spend_txn[1], node_txn[0]);
4812         check_spends!(spend_txn[2], node_txn[0], commitment_tx[0]); // All outputs
4813 }
4814
4815 #[test]
4816 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4817         let chanmon_cfgs = create_chanmon_cfgs(2);
4818         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4819         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4820         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4821
4822         // Create some initial channels
4823         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4824
4825         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4826         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4827         assert_eq!(revoked_local_txn[0].input.len(), 1);
4828         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4829
4830         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4831
4832         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4833         check_closed_broadcast!(nodes[1], true);
4834         check_added_monitors!(nodes[1], 1);
4835
4836         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4837         assert_eq!(node_txn.len(), 2);
4838         assert_eq!(node_txn[0].input.len(), 2);
4839         check_spends!(node_txn[0], revoked_local_txn[0]);
4840
4841         mine_transaction(&nodes[1], &node_txn[0]);
4842         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4843
4844         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4845         assert_eq!(spend_txn.len(), 1);
4846         check_spends!(spend_txn[0], node_txn[0]);
4847 }
4848
4849 #[test]
4850 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4851         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4852         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
4853         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4854         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4855         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4856
4857         // Create some initial channels
4858         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4859
4860         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4861         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4862         assert_eq!(revoked_local_txn[0].input.len(), 1);
4863         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4864
4865         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4866
4867         // A will generate HTLC-Timeout from revoked commitment tx
4868         mine_transaction(&nodes[0], &revoked_local_txn[0]);
4869         check_closed_broadcast!(nodes[0], true);
4870         check_added_monitors!(nodes[0], 1);
4871
4872         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4873         assert_eq!(revoked_htlc_txn.len(), 2);
4874         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4875         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4876         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4877         check_spends!(revoked_htlc_txn[1], chan_1.3);
4878
4879         // B will generate justice tx from A's revoked commitment/HTLC tx
4880         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4881         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4882         check_closed_broadcast!(nodes[1], true);
4883         check_added_monitors!(nodes[1], 1);
4884
4885         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4886         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
4887         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4888         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4889         // transactions next...
4890         assert_eq!(node_txn[0].input.len(), 3);
4891         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4892
4893         assert_eq!(node_txn[1].input.len(), 2);
4894         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
4895         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4896                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4897         } else {
4898                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4899                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4900         }
4901
4902         assert_eq!(node_txn[2].input.len(), 1);
4903         check_spends!(node_txn[2], chan_1.3);
4904
4905         mine_transaction(&nodes[1], &node_txn[1]);
4906         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
4907
4908         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4909         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4910         assert_eq!(spend_txn.len(), 1);
4911         assert_eq!(spend_txn[0].input.len(), 1);
4912         check_spends!(spend_txn[0], node_txn[1]);
4913 }
4914
4915 #[test]
4916 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4917         let mut chanmon_cfgs = create_chanmon_cfgs(2);
4918         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
4919         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4920         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4921         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4922
4923         // Create some initial channels
4924         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4925
4926         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4927         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4928         assert_eq!(revoked_local_txn[0].input.len(), 1);
4929         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4930
4931         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
4932         assert_eq!(revoked_local_txn[0].output.len(), 2);
4933
4934         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4935
4936         // B will generate HTLC-Success from revoked commitment tx
4937         mine_transaction(&nodes[1], &revoked_local_txn[0]);
4938         check_closed_broadcast!(nodes[1], true);
4939         check_added_monitors!(nodes[1], 1);
4940         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4941
4942         assert_eq!(revoked_htlc_txn.len(), 2);
4943         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4944         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4945         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4946
4947         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
4948         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
4949         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
4950
4951         // A will generate justice tx from B's revoked commitment/HTLC tx
4952         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4953         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] });
4954         check_closed_broadcast!(nodes[0], true);
4955         check_added_monitors!(nodes[0], 1);
4956
4957         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4958         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4959
4960         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
4961         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
4962         // transactions next...
4963         assert_eq!(node_txn[0].input.len(), 2);
4964         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
4965         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
4966                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4967         } else {
4968                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
4969                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4970         }
4971
4972         assert_eq!(node_txn[1].input.len(), 1);
4973         check_spends!(node_txn[1], revoked_htlc_txn[0]);
4974
4975         check_spends!(node_txn[2], chan_1.3);
4976
4977         mine_transaction(&nodes[0], &node_txn[1]);
4978         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
4979
4980         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
4981         // didn't try to generate any new transactions.
4982
4983         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4984         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
4985         assert_eq!(spend_txn.len(), 3);
4986         assert_eq!(spend_txn[0].input.len(), 1);
4987         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4988         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
4989         check_spends!(spend_txn[1], node_txn[1]); // spending justice tx output on the htlc success tx
4990         check_spends!(spend_txn[2], revoked_local_txn[0], node_txn[1]); // Both outputs
4991 }
4992
4993 #[test]
4994 fn test_onchain_to_onchain_claim() {
4995         // Test that in case of channel closure, we detect the state of output and claim HTLC
4996         // on downstream peer's remote commitment tx.
4997         // First, have C claim an HTLC against its own latest commitment transaction.
4998         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4999         // channel.
5000         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5001         // gets broadcast.
5002
5003         let chanmon_cfgs = create_chanmon_cfgs(3);
5004         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5005         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5006         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5007
5008         // Create some initial channels
5009         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5010         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5011
5012         // Rebalance the network a bit by relaying one payment through all the channels ...
5013         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5014         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5015
5016         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5017         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5018         check_spends!(commitment_tx[0], chan_2.3);
5019         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5020         check_added_monitors!(nodes[2], 1);
5021         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5022         assert!(updates.update_add_htlcs.is_empty());
5023         assert!(updates.update_fail_htlcs.is_empty());
5024         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5025         assert!(updates.update_fail_malformed_htlcs.is_empty());
5026
5027         mine_transaction(&nodes[2], &commitment_tx[0]);
5028         check_closed_broadcast!(nodes[2], true);
5029         check_added_monitors!(nodes[2], 1);
5030
5031         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5032         assert_eq!(c_txn.len(), 3);
5033         assert_eq!(c_txn[0], c_txn[2]);
5034         assert_eq!(commitment_tx[0], c_txn[1]);
5035         check_spends!(c_txn[1], chan_2.3);
5036         check_spends!(c_txn[2], c_txn[1]);
5037         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5038         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5039         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5040         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5041
5042         // 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
5043         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5044         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]});
5045         {
5046                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5047                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5048                 assert_eq!(b_txn.len(), 3);
5049                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5050                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5051                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5052                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5053                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5054                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor
5055                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5056                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5057                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5058                 b_txn.clear();
5059         }
5060         check_added_monitors!(nodes[1], 1);
5061         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5062         assert_eq!(msg_events.len(), 3);
5063         check_added_monitors!(nodes[1], 1);
5064         match msg_events[0] {
5065                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5066                 _ => panic!("Unexpected event"),
5067         }
5068         match msg_events[1] {
5069                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { .. }, node_id: _ } => {},
5070                 _ => panic!("Unexpected event"),
5071         }
5072         match msg_events[2] {
5073                 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, .. } } => {
5074                         assert!(update_add_htlcs.is_empty());
5075                         assert!(update_fail_htlcs.is_empty());
5076                         assert_eq!(update_fulfill_htlcs.len(), 1);
5077                         assert!(update_fail_malformed_htlcs.is_empty());
5078                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5079                 },
5080                 _ => panic!("Unexpected event"),
5081         };
5082         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5083         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5084         mine_transaction(&nodes[1], &commitment_tx[0]);
5085         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5086         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5087         assert_eq!(b_txn.len(), 3);
5088         check_spends!(b_txn[1], chan_1.3);
5089         check_spends!(b_txn[2], b_txn[1]);
5090         check_spends!(b_txn[0], commitment_tx[0]);
5091         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5092         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5093         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5094
5095         check_closed_broadcast!(nodes[1], true);
5096         check_added_monitors!(nodes[1], 1);
5097 }
5098
5099 #[test]
5100 fn test_duplicate_payment_hash_one_failure_one_success() {
5101         // Topology : A --> B --> C --> D
5102         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5103         // Note that because C will refuse to generate two payment secrets for the same payment hash,
5104         // we forward one of the payments onwards to D.
5105         let chanmon_cfgs = create_chanmon_cfgs(4);
5106         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5107         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5108         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5109
5110         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5111         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5112         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5113
5114         let (our_payment_preimage, duplicate_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5115
5116         let payment_secret = nodes[3].node.create_inbound_payment_for_hash(duplicate_payment_hash, None, 7200, 0).unwrap();
5117         let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(),
5118                 &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 900000, TEST_FINAL_CLTV, nodes[0].logger).unwrap();
5119         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2], &nodes[3]]], 900000, duplicate_payment_hash, payment_secret);
5120
5121         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5122         assert_eq!(commitment_txn[0].input.len(), 1);
5123         check_spends!(commitment_txn[0], chan_2.3);
5124
5125         mine_transaction(&nodes[1], &commitment_txn[0]);
5126         check_closed_broadcast!(nodes[1], true);
5127         check_added_monitors!(nodes[1], 1);
5128
5129         let htlc_timeout_tx;
5130         { // Extract one of the two HTLC-Timeout transaction
5131                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5132                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5133                 assert_eq!(node_txn.len(), 5);
5134                 check_spends!(node_txn[0], commitment_txn[0]);
5135                 assert_eq!(node_txn[0].input.len(), 1);
5136                 check_spends!(node_txn[1], commitment_txn[0]);
5137                 assert_eq!(node_txn[1].input.len(), 1);
5138                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5139                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5140                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5141                 check_spends!(node_txn[2], chan_2.3);
5142                 check_spends!(node_txn[3], node_txn[2]);
5143                 check_spends!(node_txn[4], node_txn[2]);
5144                 htlc_timeout_tx = node_txn[1].clone();
5145         }
5146
5147         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5148         mine_transaction(&nodes[2], &commitment_txn[0]);
5149         check_added_monitors!(nodes[2], 2);
5150         let events = nodes[2].node.get_and_clear_pending_msg_events();
5151         match events[0] {
5152                 MessageSendEvent::UpdateHTLCs { .. } => {},
5153                 _ => panic!("Unexpected event"),
5154         }
5155         match events[1] {
5156                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5157                 _ => panic!("Unexepected event"),
5158         }
5159         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5160         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)
5161         check_spends!(htlc_success_txn[2], chan_2.3);
5162         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5163         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5164         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5165         assert_eq!(htlc_success_txn[0].input.len(), 1);
5166         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5167         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5168         assert_eq!(htlc_success_txn[1].input.len(), 1);
5169         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5170         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5171         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5172         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5173
5174         mine_transaction(&nodes[1], &htlc_timeout_tx);
5175         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5176         expect_pending_htlcs_forwardable!(nodes[1]);
5177         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5178         assert!(htlc_updates.update_add_htlcs.is_empty());
5179         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5180         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5181         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5182         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5183         check_added_monitors!(nodes[1], 1);
5184
5185         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5186         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5187         {
5188                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5189                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5190                 assert_eq!(events.len(), 1);
5191                 match events[0] {
5192                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5193                         },
5194                         _ => { panic!("Unexpected event"); }
5195                 }
5196         }
5197         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5198
5199         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5200         mine_transaction(&nodes[1], &htlc_success_txn[0]);
5201         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5202         assert!(updates.update_add_htlcs.is_empty());
5203         assert!(updates.update_fail_htlcs.is_empty());
5204         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5205         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5206         assert!(updates.update_fail_malformed_htlcs.is_empty());
5207         check_added_monitors!(nodes[1], 1);
5208
5209         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5210         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5211
5212         let events = nodes[0].node.get_and_clear_pending_events();
5213         match events[0] {
5214                 Event::PaymentSent { ref payment_preimage } => {
5215                         assert_eq!(*payment_preimage, our_payment_preimage);
5216                 }
5217                 _ => panic!("Unexpected event"),
5218         }
5219 }
5220
5221 #[test]
5222 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5223         let chanmon_cfgs = create_chanmon_cfgs(2);
5224         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5225         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5226         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5227
5228         // Create some initial channels
5229         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5230
5231         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5232         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5233         assert_eq!(local_txn.len(), 1);
5234         assert_eq!(local_txn[0].input.len(), 1);
5235         check_spends!(local_txn[0], chan_1.3);
5236
5237         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5238         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5239         check_added_monitors!(nodes[1], 1);
5240         mine_transaction(&nodes[1], &local_txn[0]);
5241         check_added_monitors!(nodes[1], 1);
5242         let events = nodes[1].node.get_and_clear_pending_msg_events();
5243         match events[0] {
5244                 MessageSendEvent::UpdateHTLCs { .. } => {},
5245                 _ => panic!("Unexpected event"),
5246         }
5247         match events[1] {
5248                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5249                 _ => panic!("Unexepected event"),
5250         }
5251         let node_tx = {
5252                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5253                 assert_eq!(node_txn.len(), 3);
5254                 assert_eq!(node_txn[0], node_txn[2]);
5255                 assert_eq!(node_txn[1], local_txn[0]);
5256                 assert_eq!(node_txn[0].input.len(), 1);
5257                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5258                 check_spends!(node_txn[0], local_txn[0]);
5259                 node_txn[0].clone()
5260         };
5261
5262         mine_transaction(&nodes[1], &node_tx);
5263         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5264
5265         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5266         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5267         assert_eq!(spend_txn.len(), 1);
5268         check_spends!(spend_txn[0], node_tx);
5269 }
5270
5271 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5272         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5273         // unrevoked commitment transaction.
5274         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5275         // a remote RAA before they could be failed backwards (and combinations thereof).
5276         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5277         // use the same payment hashes.
5278         // Thus, we use a six-node network:
5279         //
5280         // A \         / E
5281         //    - C - D -
5282         // B /         \ F
5283         // And test where C fails back to A/B when D announces its latest commitment transaction
5284         let chanmon_cfgs = create_chanmon_cfgs(6);
5285         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5286         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5287         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5288         let logger = test_utils::TestLogger::new();
5289
5290         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5291         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5292         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5293         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5294         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5295
5296         // Rebalance and check output sanity...
5297         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5298         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5299         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5300
5301         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5302         // 0th HTLC:
5303         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
5304         // 1st HTLC:
5305         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
5306         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5307         let our_node_id = &nodes[1].node.get_our_node_id();
5308         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();
5309         // 2nd HTLC:
5310         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
5311         // 3rd HTLC:
5312         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
5313         // 4th HTLC:
5314         let (_, payment_hash_3, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5315         // 5th HTLC:
5316         let (_, payment_hash_4, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5317         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();
5318         // 6th HTLC:
5319         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());
5320         // 7th HTLC:
5321         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());
5322
5323         // 8th HTLC:
5324         let (_, payment_hash_5, _) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5325         // 9th HTLC:
5326         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();
5327         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
5328
5329         // 10th HTLC:
5330         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
5331         // 11th HTLC:
5332         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();
5333         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());
5334
5335         // Double-check that six of the new HTLC were added
5336         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5337         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5338         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5339         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5340
5341         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5342         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5343         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5344         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5345         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5346         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5347         check_added_monitors!(nodes[4], 0);
5348         expect_pending_htlcs_forwardable!(nodes[4]);
5349         check_added_monitors!(nodes[4], 1);
5350
5351         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5352         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5353         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5354         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5355         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5356         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5357
5358         // Fail 3rd below-dust and 7th above-dust HTLCs
5359         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5360         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5361         check_added_monitors!(nodes[5], 0);
5362         expect_pending_htlcs_forwardable!(nodes[5]);
5363         check_added_monitors!(nodes[5], 1);
5364
5365         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5366         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5367         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5368         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5369
5370         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5371
5372         expect_pending_htlcs_forwardable!(nodes[3]);
5373         check_added_monitors!(nodes[3], 1);
5374         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5375         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5376         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5377         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5378         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5379         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5380         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5381         if deliver_last_raa {
5382                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5383         } else {
5384                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5385         }
5386
5387         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5388         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5389         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5390         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5391         //
5392         // We now broadcast the latest commitment transaction, which *should* result in failures for
5393         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5394         // the non-broadcast above-dust HTLCs.
5395         //
5396         // Alternatively, we may broadcast the previous commitment transaction, which should only
5397         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5398         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5399
5400         if announce_latest {
5401                 mine_transaction(&nodes[2], &ds_last_commitment_tx[0]);
5402         } else {
5403                 mine_transaction(&nodes[2], &ds_prev_commitment_tx[0]);
5404         }
5405         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1);
5406         check_closed_broadcast!(nodes[2], true);
5407         expect_pending_htlcs_forwardable!(nodes[2]);
5408         check_added_monitors!(nodes[2], 3);
5409
5410         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5411         assert_eq!(cs_msgs.len(), 2);
5412         let mut a_done = false;
5413         for msg in cs_msgs {
5414                 match msg {
5415                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5416                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5417                                 // should be failed-backwards here.
5418                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5419                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5420                                         for htlc in &updates.update_fail_htlcs {
5421                                                 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 });
5422                                         }
5423                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5424                                         assert!(!a_done);
5425                                         a_done = true;
5426                                         &nodes[0]
5427                                 } else {
5428                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5429                                         for htlc in &updates.update_fail_htlcs {
5430                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5431                                         }
5432                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5433                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5434                                         &nodes[1]
5435                                 };
5436                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5437                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5438                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5439                                 if announce_latest {
5440                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5441                                         if *node_id == nodes[0].node.get_our_node_id() {
5442                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5443                                         }
5444                                 }
5445                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5446                         },
5447                         _ => panic!("Unexpected event"),
5448                 }
5449         }
5450
5451         let as_events = nodes[0].node.get_and_clear_pending_events();
5452         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5453         let mut as_failds = HashSet::new();
5454         for event in as_events.iter() {
5455                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5456                         assert!(as_failds.insert(*payment_hash));
5457                         if *payment_hash != payment_hash_2 {
5458                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5459                         } else {
5460                                 assert!(!rejected_by_dest);
5461                         }
5462                 } else { panic!("Unexpected event"); }
5463         }
5464         assert!(as_failds.contains(&payment_hash_1));
5465         assert!(as_failds.contains(&payment_hash_2));
5466         if announce_latest {
5467                 assert!(as_failds.contains(&payment_hash_3));
5468                 assert!(as_failds.contains(&payment_hash_5));
5469         }
5470         assert!(as_failds.contains(&payment_hash_6));
5471
5472         let bs_events = nodes[1].node.get_and_clear_pending_events();
5473         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5474         let mut bs_failds = HashSet::new();
5475         for event in bs_events.iter() {
5476                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5477                         assert!(bs_failds.insert(*payment_hash));
5478                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5479                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5480                         } else {
5481                                 assert!(!rejected_by_dest);
5482                         }
5483                 } else { panic!("Unexpected event"); }
5484         }
5485         assert!(bs_failds.contains(&payment_hash_1));
5486         assert!(bs_failds.contains(&payment_hash_2));
5487         if announce_latest {
5488                 assert!(bs_failds.contains(&payment_hash_4));
5489         }
5490         assert!(bs_failds.contains(&payment_hash_5));
5491
5492         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5493         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5494         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5495         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5496         // PaymentFailureNetworkUpdates.
5497         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5498         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5499         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5500         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5501         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5502                 match event {
5503                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5504                         _ => panic!("Unexpected event"),
5505                 }
5506         }
5507 }
5508
5509 #[test]
5510 fn test_fail_backwards_latest_remote_announce_a() {
5511         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5512 }
5513
5514 #[test]
5515 fn test_fail_backwards_latest_remote_announce_b() {
5516         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5517 }
5518
5519 #[test]
5520 fn test_fail_backwards_previous_remote_announce() {
5521         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5522         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5523         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5524 }
5525
5526 #[test]
5527 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5528         let chanmon_cfgs = create_chanmon_cfgs(2);
5529         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5530         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5531         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5532
5533         // Create some initial channels
5534         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5535
5536         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5537         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5538         assert_eq!(local_txn[0].input.len(), 1);
5539         check_spends!(local_txn[0], chan_1.3);
5540
5541         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5542         mine_transaction(&nodes[0], &local_txn[0]);
5543         check_closed_broadcast!(nodes[0], true);
5544         check_added_monitors!(nodes[0], 1);
5545
5546         let htlc_timeout = {
5547                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5548                 assert_eq!(node_txn[0].input.len(), 1);
5549                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5550                 check_spends!(node_txn[0], local_txn[0]);
5551                 node_txn[0].clone()
5552         };
5553
5554         mine_transaction(&nodes[0], &htlc_timeout);
5555         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5556         expect_payment_failed!(nodes[0], our_payment_hash, true);
5557
5558         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5559         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5560         assert_eq!(spend_txn.len(), 3);
5561         check_spends!(spend_txn[0], local_txn[0]);
5562         check_spends!(spend_txn[1], htlc_timeout);
5563         check_spends!(spend_txn[2], local_txn[0], htlc_timeout);
5564 }
5565
5566 #[test]
5567 fn test_key_derivation_params() {
5568         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5569         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5570         // let us re-derive the channel key set to then derive a delayed_payment_key.
5571
5572         let chanmon_cfgs = create_chanmon_cfgs(3);
5573
5574         // We manually create the node configuration to backup the seed.
5575         let seed = [42; 32];
5576         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5577         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);
5578         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 };
5579         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5580         node_cfgs.remove(0);
5581         node_cfgs.insert(0, node);
5582
5583         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5584         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5585
5586         // Create some initial channels
5587         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5588         // for node 0
5589         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5590         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5591         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5592
5593         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5594         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5595         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5596         assert_eq!(local_txn_1[0].input.len(), 1);
5597         check_spends!(local_txn_1[0], chan_1.3);
5598
5599         // We check funding pubkey are unique
5600         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]));
5601         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]));
5602         if from_0_funding_key_0 == from_1_funding_key_0
5603             || from_0_funding_key_0 == from_1_funding_key_1
5604             || from_0_funding_key_1 == from_1_funding_key_0
5605             || from_0_funding_key_1 == from_1_funding_key_1 {
5606                 panic!("Funding pubkeys aren't unique");
5607         }
5608
5609         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5610         mine_transaction(&nodes[0], &local_txn_1[0]);
5611         check_closed_broadcast!(nodes[0], true);
5612         check_added_monitors!(nodes[0], 1);
5613
5614         let htlc_timeout = {
5615                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5616                 assert_eq!(node_txn[0].input.len(), 1);
5617                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5618                 check_spends!(node_txn[0], local_txn_1[0]);
5619                 node_txn[0].clone()
5620         };
5621
5622         mine_transaction(&nodes[0], &htlc_timeout);
5623         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5624         expect_payment_failed!(nodes[0], our_payment_hash, true);
5625
5626         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5627         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5628         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5629         assert_eq!(spend_txn.len(), 3);
5630         check_spends!(spend_txn[0], local_txn_1[0]);
5631         check_spends!(spend_txn[1], htlc_timeout);
5632         check_spends!(spend_txn[2], local_txn_1[0], htlc_timeout);
5633 }
5634
5635 #[test]
5636 fn test_static_output_closing_tx() {
5637         let chanmon_cfgs = create_chanmon_cfgs(2);
5638         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5639         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5640         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5641
5642         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5643
5644         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5645         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5646
5647         mine_transaction(&nodes[0], &closing_tx);
5648         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
5649
5650         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5651         assert_eq!(spend_txn.len(), 1);
5652         check_spends!(spend_txn[0], closing_tx);
5653
5654         mine_transaction(&nodes[1], &closing_tx);
5655         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
5656
5657         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5658         assert_eq!(spend_txn.len(), 1);
5659         check_spends!(spend_txn[0], closing_tx);
5660 }
5661
5662 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5663         let chanmon_cfgs = create_chanmon_cfgs(2);
5664         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5665         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5666         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5667         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5668
5669         let (our_payment_preimage, _, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5670
5671         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5672         // present in B's local commitment transaction, but none of A's commitment transactions.
5673         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5674         check_added_monitors!(nodes[1], 1);
5675
5676         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5677         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5678         let events = nodes[0].node.get_and_clear_pending_events();
5679         assert_eq!(events.len(), 1);
5680         match events[0] {
5681                 Event::PaymentSent { payment_preimage } => {
5682                         assert_eq!(payment_preimage, our_payment_preimage);
5683                 },
5684                 _ => panic!("Unexpected event"),
5685         }
5686
5687         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5688         check_added_monitors!(nodes[0], 1);
5689         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5690         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5691         check_added_monitors!(nodes[1], 1);
5692
5693         let starting_block = nodes[1].best_block_info();
5694         let mut block = Block {
5695                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5696                 txdata: vec![],
5697         };
5698         for _ in starting_block.1 + 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + starting_block.1 + 2 {
5699                 connect_block(&nodes[1], &block);
5700                 block.header.prev_blockhash = block.block_hash();
5701         }
5702         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5703         check_closed_broadcast!(nodes[1], true);
5704         check_added_monitors!(nodes[1], 1);
5705 }
5706
5707 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5708         let chanmon_cfgs = create_chanmon_cfgs(2);
5709         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5710         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5711         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5712         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5713         let logger = test_utils::TestLogger::new();
5714
5715         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1]);
5716         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5717         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();
5718         nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5719         check_added_monitors!(nodes[0], 1);
5720
5721         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5722
5723         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5724         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5725         // to "time out" the HTLC.
5726
5727         let starting_block = nodes[1].best_block_info();
5728         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5729
5730         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + starting_block.1 + 2 {
5731                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()});
5732                 header.prev_blockhash = header.block_hash();
5733         }
5734         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5735         check_closed_broadcast!(nodes[0], true);
5736         check_added_monitors!(nodes[0], 1);
5737 }
5738
5739 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5740         let chanmon_cfgs = create_chanmon_cfgs(3);
5741         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5742         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5743         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5744         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5745
5746         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5747         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5748         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5749         // actually revoked.
5750         let htlc_value = if use_dust { 50000 } else { 3000000 };
5751         let (_, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5752         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5753         expect_pending_htlcs_forwardable!(nodes[1]);
5754         check_added_monitors!(nodes[1], 1);
5755
5756         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5757         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5758         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5759         check_added_monitors!(nodes[0], 1);
5760         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5761         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5762         check_added_monitors!(nodes[1], 1);
5763         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5764         check_added_monitors!(nodes[1], 1);
5765         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5766
5767         if check_revoke_no_close {
5768                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5769                 check_added_monitors!(nodes[0], 1);
5770         }
5771
5772         let starting_block = nodes[1].best_block_info();
5773         let mut block = Block {
5774                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5775                 txdata: vec![],
5776         };
5777         for _ in starting_block.1 + 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 2 {
5778                 connect_block(&nodes[0], &block);
5779                 block.header.prev_blockhash = block.block_hash();
5780         }
5781         if !check_revoke_no_close {
5782                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5783                 check_closed_broadcast!(nodes[0], true);
5784                 check_added_monitors!(nodes[0], 1);
5785         } else {
5786                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5787         }
5788 }
5789
5790 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5791 // There are only a few cases to test here:
5792 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5793 //    broadcastable commitment transactions result in channel closure,
5794 //  * its included in an unrevoked-but-previous remote commitment transaction,
5795 //  * its included in the latest remote or local commitment transactions.
5796 // We test each of the three possible commitment transactions individually and use both dust and
5797 // non-dust HTLCs.
5798 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5799 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5800 // tested for at least one of the cases in other tests.
5801 #[test]
5802 fn htlc_claim_single_commitment_only_a() {
5803         do_htlc_claim_local_commitment_only(true);
5804         do_htlc_claim_local_commitment_only(false);
5805
5806         do_htlc_claim_current_remote_commitment_only(true);
5807         do_htlc_claim_current_remote_commitment_only(false);
5808 }
5809
5810 #[test]
5811 fn htlc_claim_single_commitment_only_b() {
5812         do_htlc_claim_previous_remote_commitment_only(true, false);
5813         do_htlc_claim_previous_remote_commitment_only(false, false);
5814         do_htlc_claim_previous_remote_commitment_only(true, true);
5815         do_htlc_claim_previous_remote_commitment_only(false, true);
5816 }
5817
5818 #[test]
5819 #[should_panic]
5820 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5821         let chanmon_cfgs = create_chanmon_cfgs(2);
5822         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5823         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5824         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5825         //Force duplicate channel ids
5826         for node in nodes.iter() {
5827                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5828         }
5829
5830         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5831         let channel_value_satoshis=10000;
5832         let push_msat=10001;
5833         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5834         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5835         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
5836
5837         //Create a second channel with a channel_id collision
5838         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5839 }
5840
5841 #[test]
5842 fn bolt2_open_channel_sending_node_checks_part2() {
5843         let chanmon_cfgs = create_chanmon_cfgs(2);
5844         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5845         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5846         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5847
5848         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5849         let channel_value_satoshis=2^24;
5850         let push_msat=10001;
5851         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5852
5853         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5854         let channel_value_satoshis=10000;
5855         // Test when push_msat is equal to 1000 * funding_satoshis.
5856         let push_msat=1000*channel_value_satoshis+1;
5857         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5858
5859         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5860         let channel_value_satoshis=10000;
5861         let push_msat=10001;
5862         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
5863         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5864         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5865
5866         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5867         // 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
5868         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5869
5870         // 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.
5871         assert!(BREAKDOWN_TIMEOUT>0);
5872         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5873
5874         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5875         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
5876         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5877
5878         // 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.
5879         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5880         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5881         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5882         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
5883         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5884 }
5885
5886 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
5887 // originated from our node, its failure is surfaced to the user. We trigger this failure to
5888 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
5889 // is no longer affordable once it's freed.
5890 #[test]
5891 fn test_fail_holding_cell_htlc_upon_free() {
5892         let chanmon_cfgs = create_chanmon_cfgs(2);
5893         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5894         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5895         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5896         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5897         let logger = test_utils::TestLogger::new();
5898
5899         // First nodes[0] generates an update_fee, setting the channel's
5900         // pending_update_fee.
5901         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
5902         check_added_monitors!(nodes[0], 1);
5903
5904         let events = nodes[0].node.get_and_clear_pending_msg_events();
5905         assert_eq!(events.len(), 1);
5906         let (update_msg, commitment_signed) = match events[0] {
5907                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5908                         (update_fee.as_ref(), commitment_signed)
5909                 },
5910                 _ => panic!("Unexpected event"),
5911         };
5912
5913         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5914
5915         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5916         let channel_reserve = chan_stat.channel_reserve_msat;
5917         let feerate = get_feerate!(nodes[0], chan.2);
5918
5919         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5920         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
5921         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
5922         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5923         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();
5924
5925         // Send a payment which passes reserve checks but gets stuck in the holding cell.
5926         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
5927         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5928         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
5929
5930         // Flush the pending fee update.
5931         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
5932         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5933         check_added_monitors!(nodes[1], 1);
5934         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
5935         check_added_monitors!(nodes[0], 1);
5936
5937         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
5938         // HTLC, but now that the fee has been raised the payment will now fail, causing
5939         // us to surface its failure to the user.
5940         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5941         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
5942         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
5943         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);
5944         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
5945
5946         // Check that the payment failed to be sent out.
5947         let events = nodes[0].node.get_and_clear_pending_events();
5948         assert_eq!(events.len(), 1);
5949         match &events[0] {
5950                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
5951                         assert_eq!(our_payment_hash.clone(), *payment_hash);
5952                         assert_eq!(*rejected_by_dest, false);
5953                         assert_eq!(*error_code, None);
5954                         assert_eq!(*error_data, None);
5955                 },
5956                 _ => panic!("Unexpected event"),
5957         }
5958 }
5959
5960 // Test that if multiple HTLCs are released from the holding cell and one is
5961 // valid but the other is no longer valid upon release, the valid HTLC can be
5962 // successfully completed while the other one fails as expected.
5963 #[test]
5964 fn test_free_and_fail_holding_cell_htlcs() {
5965         let chanmon_cfgs = create_chanmon_cfgs(2);
5966         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5967         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5968         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5969         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
5970         let logger = test_utils::TestLogger::new();
5971
5972         // First nodes[0] generates an update_fee, setting the channel's
5973         // pending_update_fee.
5974         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
5975         check_added_monitors!(nodes[0], 1);
5976
5977         let events = nodes[0].node.get_and_clear_pending_msg_events();
5978         assert_eq!(events.len(), 1);
5979         let (update_msg, commitment_signed) = match events[0] {
5980                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
5981                         (update_fee.as_ref(), commitment_signed)
5982                 },
5983                 _ => panic!("Unexpected event"),
5984         };
5985
5986         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
5987
5988         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
5989         let channel_reserve = chan_stat.channel_reserve_msat;
5990         let feerate = get_feerate!(nodes[0], chan.2);
5991
5992         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
5993         let (payment_preimage_1, payment_hash_1, payment_secret_1) = get_payment_preimage_hash!(nodes[1]);
5994         let amt_1 = 20000;
5995         let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
5996         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
5997         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5998         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();
5999         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();
6000
6001         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6002         nodes[0].node.send_payment(&route_1, payment_hash_1, &Some(payment_secret_1)).unwrap();
6003         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6004         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6005         nodes[0].node.send_payment(&route_2, payment_hash_2, &Some(payment_secret_2)).unwrap();
6006         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6007         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6008
6009         // Flush the pending fee update.
6010         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6011         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6012         check_added_monitors!(nodes[1], 1);
6013         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6014         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6015         check_added_monitors!(nodes[0], 2);
6016
6017         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6018         // but now that the fee has been raised the second payment will now fail, causing us
6019         // to surface its failure to the user. The first payment should succeed.
6020         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6021         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6022         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6023         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);
6024         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6025
6026         // Check that the second payment failed to be sent out.
6027         let events = nodes[0].node.get_and_clear_pending_events();
6028         assert_eq!(events.len(), 1);
6029         match &events[0] {
6030                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6031                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6032                         assert_eq!(*rejected_by_dest, false);
6033                         assert_eq!(*error_code, None);
6034                         assert_eq!(*error_data, None);
6035                 },
6036                 _ => panic!("Unexpected event"),
6037         }
6038
6039         // Complete the first payment and the RAA from the fee update.
6040         let (payment_event, send_raa_event) = {
6041                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6042                 assert_eq!(msgs.len(), 2);
6043                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6044         };
6045         let raa = match send_raa_event {
6046                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6047                 _ => panic!("Unexpected event"),
6048         };
6049         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6050         check_added_monitors!(nodes[1], 1);
6051         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6052         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6053         let events = nodes[1].node.get_and_clear_pending_events();
6054         assert_eq!(events.len(), 1);
6055         match events[0] {
6056                 Event::PendingHTLCsForwardable { .. } => {},
6057                 _ => panic!("Unexpected event"),
6058         }
6059         nodes[1].node.process_pending_htlc_forwards();
6060         let events = nodes[1].node.get_and_clear_pending_events();
6061         assert_eq!(events.len(), 1);
6062         match events[0] {
6063                 Event::PaymentReceived { .. } => {},
6064                 _ => panic!("Unexpected event"),
6065         }
6066         nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
6067         check_added_monitors!(nodes[1], 1);
6068         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6069         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6070         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6071         let events = nodes[0].node.get_and_clear_pending_events();
6072         assert_eq!(events.len(), 1);
6073         match events[0] {
6074                 Event::PaymentSent { ref payment_preimage } => {
6075                         assert_eq!(*payment_preimage, payment_preimage_1);
6076                 }
6077                 _ => panic!("Unexpected event"),
6078         }
6079 }
6080
6081 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6082 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6083 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6084 // once it's freed.
6085 #[test]
6086 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6087         let chanmon_cfgs = create_chanmon_cfgs(3);
6088         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6089         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6090         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6091         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6092         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6093         let logger = test_utils::TestLogger::new();
6094
6095         // First nodes[1] generates an update_fee, setting the channel's
6096         // pending_update_fee.
6097         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6098         check_added_monitors!(nodes[1], 1);
6099
6100         let events = nodes[1].node.get_and_clear_pending_msg_events();
6101         assert_eq!(events.len(), 1);
6102         let (update_msg, commitment_signed) = match events[0] {
6103                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6104                         (update_fee.as_ref(), commitment_signed)
6105                 },
6106                 _ => panic!("Unexpected event"),
6107         };
6108
6109         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6110
6111         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6112         let channel_reserve = chan_stat.channel_reserve_msat;
6113         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6114
6115         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6116         let feemsat = 239;
6117         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6118         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6119         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6120         let payment_event = {
6121                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6122                 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();
6123                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6124                 check_added_monitors!(nodes[0], 1);
6125
6126                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6127                 assert_eq!(events.len(), 1);
6128
6129                 SendEvent::from_event(events.remove(0))
6130         };
6131         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6132         check_added_monitors!(nodes[1], 0);
6133         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6134         expect_pending_htlcs_forwardable!(nodes[1]);
6135
6136         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6137         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6138
6139         // Flush the pending fee update.
6140         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6141         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6142         check_added_monitors!(nodes[2], 1);
6143         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6144         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6145         check_added_monitors!(nodes[1], 2);
6146
6147         // A final RAA message is generated to finalize the fee update.
6148         let events = nodes[1].node.get_and_clear_pending_msg_events();
6149         assert_eq!(events.len(), 1);
6150
6151         let raa_msg = match &events[0] {
6152                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6153                         msg.clone()
6154                 },
6155                 _ => panic!("Unexpected event"),
6156         };
6157
6158         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6159         check_added_monitors!(nodes[2], 1);
6160         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6161
6162         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6163         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6164         assert_eq!(process_htlc_forwards_event.len(), 1);
6165         match &process_htlc_forwards_event[0] {
6166                 &Event::PendingHTLCsForwardable { .. } => {},
6167                 _ => panic!("Unexpected event"),
6168         }
6169
6170         // In response, we call ChannelManager's process_pending_htlc_forwards
6171         nodes[1].node.process_pending_htlc_forwards();
6172         check_added_monitors!(nodes[1], 1);
6173
6174         // This causes the HTLC to be failed backwards.
6175         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6176         assert_eq!(fail_event.len(), 1);
6177         let (fail_msg, commitment_signed) = match &fail_event[0] {
6178                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6179                         assert_eq!(updates.update_add_htlcs.len(), 0);
6180                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6181                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6182                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6183                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6184                 },
6185                 _ => panic!("Unexpected event"),
6186         };
6187
6188         // Pass the failure messages back to nodes[0].
6189         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6190         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6191
6192         // Complete the HTLC failure+removal process.
6193         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6194         check_added_monitors!(nodes[0], 1);
6195         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6196         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6197         check_added_monitors!(nodes[1], 2);
6198         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6199         assert_eq!(final_raa_event.len(), 1);
6200         let raa = match &final_raa_event[0] {
6201                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6202                 _ => panic!("Unexpected event"),
6203         };
6204         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6205         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6206         assert_eq!(fail_msg_event.len(), 1);
6207         match &fail_msg_event[0] {
6208                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6209                 _ => panic!("Unexpected event"),
6210         }
6211         let failure_event = nodes[0].node.get_and_clear_pending_events();
6212         assert_eq!(failure_event.len(), 1);
6213         match &failure_event[0] {
6214                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6215                         assert!(!rejected_by_dest);
6216                 },
6217                 _ => panic!("Unexpected event"),
6218         }
6219         check_added_monitors!(nodes[0], 1);
6220 }
6221
6222 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6223 // 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.
6224 //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.
6225
6226 #[test]
6227 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6228         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6229         let chanmon_cfgs = create_chanmon_cfgs(2);
6230         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6231         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6232         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6233         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6234
6235         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6236         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6237         let logger = test_utils::TestLogger::new();
6238         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();
6239         route.paths[0][0].fee_msat = 100;
6240
6241         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6242                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6243         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6244         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6245 }
6246
6247 #[test]
6248 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6249         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6250         let chanmon_cfgs = create_chanmon_cfgs(2);
6251         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6252         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6253         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6254         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6255         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6256
6257         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6258         let logger = test_utils::TestLogger::new();
6259         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();
6260         route.paths[0][0].fee_msat = 0;
6261         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6262                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6263
6264         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6265         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6266 }
6267
6268 #[test]
6269 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6270         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6271         let chanmon_cfgs = create_chanmon_cfgs(2);
6272         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6273         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6274         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6275         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6276
6277         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6278         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6279         let logger = test_utils::TestLogger::new();
6280         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();
6281         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6282         check_added_monitors!(nodes[0], 1);
6283         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6284         updates.update_add_htlcs[0].amount_msat = 0;
6285
6286         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6287         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6288         check_closed_broadcast!(nodes[1], true).unwrap();
6289         check_added_monitors!(nodes[1], 1);
6290 }
6291
6292 #[test]
6293 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6294         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6295         //It is enforced when constructing a route.
6296         let chanmon_cfgs = create_chanmon_cfgs(2);
6297         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6298         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6299         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6300         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6301         let logger = test_utils::TestLogger::new();
6302
6303         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6304
6305         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6306         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();
6307         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::RouteError { ref err },
6308                 assert_eq!(err, &"Channel CLTV overflowed?"));
6309 }
6310
6311 #[test]
6312 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6313         //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.
6314         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6315         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6316         let chanmon_cfgs = create_chanmon_cfgs(2);
6317         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6318         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6319         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6320         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6321         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6322
6323         let logger = test_utils::TestLogger::new();
6324         for i in 0..max_accepted_htlcs {
6325                 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6326                 let payment_event = {
6327                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6328                         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();
6329                         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6330                         check_added_monitors!(nodes[0], 1);
6331
6332                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6333                         assert_eq!(events.len(), 1);
6334                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6335                                 assert_eq!(htlcs[0].htlc_id, i);
6336                         } else {
6337                                 assert!(false);
6338                         }
6339                         SendEvent::from_event(events.remove(0))
6340                 };
6341                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6342                 check_added_monitors!(nodes[1], 0);
6343                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6344
6345                 expect_pending_htlcs_forwardable!(nodes[1]);
6346                 expect_payment_received!(nodes[1], our_payment_hash, our_payment_secret, 100000);
6347         }
6348         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6349         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6350         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();
6351         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6352                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6353
6354         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6355         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6356 }
6357
6358 #[test]
6359 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6360         //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.
6361         let chanmon_cfgs = create_chanmon_cfgs(2);
6362         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6363         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6364         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6365         let channel_value = 100000;
6366         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6367         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6368
6369         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6370
6371         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6372         // Manually create a route over our max in flight (which our router normally automatically
6373         // limits us to.
6374         let route = Route { paths: vec![vec![RouteHop {
6375            pubkey: nodes[1].node.get_our_node_id(), node_features: NodeFeatures::known(), channel_features: ChannelFeatures::known(),
6376            short_channel_id: nodes[1].node.list_usable_channels()[0].short_channel_id.unwrap(),
6377            fee_msat: max_in_flight + 1, cltv_expiry_delta: TEST_FINAL_CLTV
6378         }]] };
6379         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)), true, APIError::ChannelUnavailable { ref err },
6380                 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)));
6381
6382         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6383         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);
6384
6385         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6386 }
6387
6388 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6389 #[test]
6390 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6391         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6392         let chanmon_cfgs = create_chanmon_cfgs(2);
6393         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6394         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6395         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6396         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6397         let htlc_minimum_msat: u64;
6398         {
6399                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6400                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6401                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6402         }
6403
6404         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6405         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6406         let logger = test_utils::TestLogger::new();
6407         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();
6408         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6409         check_added_monitors!(nodes[0], 1);
6410         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6411         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6412         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6413         assert!(nodes[1].node.list_channels().is_empty());
6414         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6415         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()));
6416         check_added_monitors!(nodes[1], 1);
6417 }
6418
6419 #[test]
6420 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6421         //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
6422         let chanmon_cfgs = create_chanmon_cfgs(2);
6423         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6424         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6425         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6426         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6427         let logger = test_utils::TestLogger::new();
6428
6429         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6430         let channel_reserve = chan_stat.channel_reserve_msat;
6431         let feerate = get_feerate!(nodes[0], chan.2);
6432         // The 2* and +1 are for the fee spike reserve.
6433         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6434
6435         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6436         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6437         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6438         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();
6439         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6440         check_added_monitors!(nodes[0], 1);
6441         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6442
6443         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6444         // at this time channel-initiatee receivers are not required to enforce that senders
6445         // respect the fee_spike_reserve.
6446         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6447         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6448
6449         assert!(nodes[1].node.list_channels().is_empty());
6450         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6451         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6452         check_added_monitors!(nodes[1], 1);
6453 }
6454
6455 #[test]
6456 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6457         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6458         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6459         let chanmon_cfgs = create_chanmon_cfgs(2);
6460         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6461         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6462         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6463         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6464         let logger = test_utils::TestLogger::new();
6465
6466         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6467         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6468
6469         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6470         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();
6471
6472         let cur_height = nodes[0].node.best_block.read().unwrap().height() + 1;
6473         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6474         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &Some(our_payment_secret), cur_height).unwrap();
6475         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6476
6477         let mut msg = msgs::UpdateAddHTLC {
6478                 channel_id: chan.2,
6479                 htlc_id: 0,
6480                 amount_msat: 1000,
6481                 payment_hash: our_payment_hash,
6482                 cltv_expiry: htlc_cltv,
6483                 onion_routing_packet: onion_packet.clone(),
6484         };
6485
6486         for i in 0..super::channel::OUR_MAX_HTLCS {
6487                 msg.htlc_id = i as u64;
6488                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6489         }
6490         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6491         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6492
6493         assert!(nodes[1].node.list_channels().is_empty());
6494         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6495         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6496         check_added_monitors!(nodes[1], 1);
6497 }
6498
6499 #[test]
6500 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6501         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6502         let chanmon_cfgs = create_chanmon_cfgs(2);
6503         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6504         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6505         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6506         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6507         let logger = test_utils::TestLogger::new();
6508
6509         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6510         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6511         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();
6512         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6513         check_added_monitors!(nodes[0], 1);
6514         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6515         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6516         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6517
6518         assert!(nodes[1].node.list_channels().is_empty());
6519         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6520         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6521         check_added_monitors!(nodes[1], 1);
6522 }
6523
6524 #[test]
6525 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6526         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6527         let chanmon_cfgs = create_chanmon_cfgs(2);
6528         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6529         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6530         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6531         let logger = test_utils::TestLogger::new();
6532
6533         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6534         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6535         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6536         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();
6537         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6538         check_added_monitors!(nodes[0], 1);
6539         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6540         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6541         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6542
6543         assert!(nodes[1].node.list_channels().is_empty());
6544         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6545         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6546         check_added_monitors!(nodes[1], 1);
6547 }
6548
6549 #[test]
6550 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6551         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6552         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6553         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6554         let chanmon_cfgs = create_chanmon_cfgs(2);
6555         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6556         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6557         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6558         let logger = test_utils::TestLogger::new();
6559
6560         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6561         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6562         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6563         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();
6564         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6565         check_added_monitors!(nodes[0], 1);
6566         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6567         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6568
6569         //Disconnect and Reconnect
6570         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6571         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6572         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6573         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6574         assert_eq!(reestablish_1.len(), 1);
6575         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6576         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6577         assert_eq!(reestablish_2.len(), 1);
6578         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6579         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6580         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6581         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6582
6583         //Resend HTLC
6584         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6585         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6586         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6587         check_added_monitors!(nodes[1], 1);
6588         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6589
6590         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6591
6592         assert!(nodes[1].node.list_channels().is_empty());
6593         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6594         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6595         check_added_monitors!(nodes[1], 1);
6596 }
6597
6598 #[test]
6599 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6600         //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.
6601
6602         let chanmon_cfgs = create_chanmon_cfgs(2);
6603         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6604         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6605         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6606         let logger = test_utils::TestLogger::new();
6607         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6608         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6609         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6610         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();
6611         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6612
6613         check_added_monitors!(nodes[0], 1);
6614         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6615         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6616
6617         let update_msg = msgs::UpdateFulfillHTLC{
6618                 channel_id: chan.2,
6619                 htlc_id: 0,
6620                 payment_preimage: our_payment_preimage,
6621         };
6622
6623         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6624
6625         assert!(nodes[0].node.list_channels().is_empty());
6626         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6627         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()));
6628         check_added_monitors!(nodes[0], 1);
6629 }
6630
6631 #[test]
6632 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6633         //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.
6634
6635         let chanmon_cfgs = create_chanmon_cfgs(2);
6636         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6637         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6638         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6639         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6640         let logger = test_utils::TestLogger::new();
6641
6642         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6643         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6644         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();
6645         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6646         check_added_monitors!(nodes[0], 1);
6647         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6648         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6649
6650         let update_msg = msgs::UpdateFailHTLC{
6651                 channel_id: chan.2,
6652                 htlc_id: 0,
6653                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6654         };
6655
6656         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6657
6658         assert!(nodes[0].node.list_channels().is_empty());
6659         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6660         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()));
6661         check_added_monitors!(nodes[0], 1);
6662 }
6663
6664 #[test]
6665 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6666         //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.
6667
6668         let chanmon_cfgs = create_chanmon_cfgs(2);
6669         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6670         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6671         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6672         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6673         let logger = test_utils::TestLogger::new();
6674
6675         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6676         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6677         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();
6678         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6679         check_added_monitors!(nodes[0], 1);
6680         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6681         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6682         let update_msg = msgs::UpdateFailMalformedHTLC{
6683                 channel_id: chan.2,
6684                 htlc_id: 0,
6685                 sha256_of_onion: [1; 32],
6686                 failure_code: 0x8000,
6687         };
6688
6689         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6690
6691         assert!(nodes[0].node.list_channels().is_empty());
6692         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6693         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()));
6694         check_added_monitors!(nodes[0], 1);
6695 }
6696
6697 #[test]
6698 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6699         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6700
6701         let chanmon_cfgs = create_chanmon_cfgs(2);
6702         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6703         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6704         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6705         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6706
6707         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6708
6709         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6710         check_added_monitors!(nodes[1], 1);
6711
6712         let events = nodes[1].node.get_and_clear_pending_msg_events();
6713         assert_eq!(events.len(), 1);
6714         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6715                 match events[0] {
6716                         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, .. } } => {
6717                                 assert!(update_add_htlcs.is_empty());
6718                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6719                                 assert!(update_fail_htlcs.is_empty());
6720                                 assert!(update_fail_malformed_htlcs.is_empty());
6721                                 assert!(update_fee.is_none());
6722                                 update_fulfill_htlcs[0].clone()
6723                         },
6724                         _ => panic!("Unexpected event"),
6725                 }
6726         };
6727
6728         update_fulfill_msg.htlc_id = 1;
6729
6730         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6731
6732         assert!(nodes[0].node.list_channels().is_empty());
6733         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6734         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6735         check_added_monitors!(nodes[0], 1);
6736 }
6737
6738 #[test]
6739 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6740         //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.
6741
6742         let chanmon_cfgs = create_chanmon_cfgs(2);
6743         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6744         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6745         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6746         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6747
6748         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6749
6750         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6751         check_added_monitors!(nodes[1], 1);
6752
6753         let events = nodes[1].node.get_and_clear_pending_msg_events();
6754         assert_eq!(events.len(), 1);
6755         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6756                 match events[0] {
6757                         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, .. } } => {
6758                                 assert!(update_add_htlcs.is_empty());
6759                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6760                                 assert!(update_fail_htlcs.is_empty());
6761                                 assert!(update_fail_malformed_htlcs.is_empty());
6762                                 assert!(update_fee.is_none());
6763                                 update_fulfill_htlcs[0].clone()
6764                         },
6765                         _ => panic!("Unexpected event"),
6766                 }
6767         };
6768
6769         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6770
6771         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6772
6773         assert!(nodes[0].node.list_channels().is_empty());
6774         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6775         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6776         check_added_monitors!(nodes[0], 1);
6777 }
6778
6779 #[test]
6780 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6781         //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.
6782
6783         let chanmon_cfgs = create_chanmon_cfgs(2);
6784         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6785         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6786         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6787         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6788         let logger = test_utils::TestLogger::new();
6789
6790         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[1]);
6791         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6792         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();
6793         nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6794         check_added_monitors!(nodes[0], 1);
6795
6796         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6797         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6798
6799         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6800         check_added_monitors!(nodes[1], 0);
6801         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6802
6803         let events = nodes[1].node.get_and_clear_pending_msg_events();
6804
6805         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6806                 match events[0] {
6807                         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, .. } } => {
6808                                 assert!(update_add_htlcs.is_empty());
6809                                 assert!(update_fulfill_htlcs.is_empty());
6810                                 assert!(update_fail_htlcs.is_empty());
6811                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6812                                 assert!(update_fee.is_none());
6813                                 update_fail_malformed_htlcs[0].clone()
6814                         },
6815                         _ => panic!("Unexpected event"),
6816                 }
6817         };
6818         update_msg.failure_code &= !0x8000;
6819         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6820
6821         assert!(nodes[0].node.list_channels().is_empty());
6822         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6823         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6824         check_added_monitors!(nodes[0], 1);
6825 }
6826
6827 #[test]
6828 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6829         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6830         //    * 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.
6831
6832         let chanmon_cfgs = create_chanmon_cfgs(3);
6833         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6834         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6835         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6836         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6837         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6838         let logger = test_utils::TestLogger::new();
6839
6840         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(nodes[2]);
6841
6842         //First hop
6843         let mut payment_event = {
6844                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6845                 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();
6846                 nodes[0].node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
6847                 check_added_monitors!(nodes[0], 1);
6848                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6849                 assert_eq!(events.len(), 1);
6850                 SendEvent::from_event(events.remove(0))
6851         };
6852         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6853         check_added_monitors!(nodes[1], 0);
6854         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6855         expect_pending_htlcs_forwardable!(nodes[1]);
6856         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6857         assert_eq!(events_2.len(), 1);
6858         check_added_monitors!(nodes[1], 1);
6859         payment_event = SendEvent::from_event(events_2.remove(0));
6860         assert_eq!(payment_event.msgs.len(), 1);
6861
6862         //Second Hop
6863         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6864         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6865         check_added_monitors!(nodes[2], 0);
6866         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6867
6868         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6869         assert_eq!(events_3.len(), 1);
6870         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6871                 match events_3[0] {
6872                         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 } } => {
6873                                 assert!(update_add_htlcs.is_empty());
6874                                 assert!(update_fulfill_htlcs.is_empty());
6875                                 assert!(update_fail_htlcs.is_empty());
6876                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6877                                 assert!(update_fee.is_none());
6878                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6879                         },
6880                         _ => panic!("Unexpected event"),
6881                 }
6882         };
6883
6884         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6885
6886         check_added_monitors!(nodes[1], 0);
6887         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6888         expect_pending_htlcs_forwardable!(nodes[1]);
6889         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6890         assert_eq!(events_4.len(), 1);
6891
6892         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6893         match events_4[0] {
6894                 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, .. } } => {
6895                         assert!(update_add_htlcs.is_empty());
6896                         assert!(update_fulfill_htlcs.is_empty());
6897                         assert_eq!(update_fail_htlcs.len(), 1);
6898                         assert!(update_fail_malformed_htlcs.is_empty());
6899                         assert!(update_fee.is_none());
6900                 },
6901                 _ => panic!("Unexpected event"),
6902         };
6903
6904         check_added_monitors!(nodes[1], 1);
6905 }
6906
6907 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6908         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6909         // 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
6910         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6911
6912         let mut chanmon_cfgs = create_chanmon_cfgs(2);
6913         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
6914         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6915         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6916         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6917         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6918
6919         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
6920
6921         // We route 2 dust-HTLCs between A and B
6922         let (_, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6923         let (_, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6924         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6925
6926         // Cache one local commitment tx as previous
6927         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6928
6929         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6930         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
6931         check_added_monitors!(nodes[1], 0);
6932         expect_pending_htlcs_forwardable!(nodes[1]);
6933         check_added_monitors!(nodes[1], 1);
6934
6935         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6936         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6937         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6938         check_added_monitors!(nodes[0], 1);
6939
6940         // Cache one local commitment tx as lastest
6941         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6942
6943         let events = nodes[0].node.get_and_clear_pending_msg_events();
6944         match events[0] {
6945                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6946                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6947                 },
6948                 _ => panic!("Unexpected event"),
6949         }
6950         match events[1] {
6951                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6952                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6953                 },
6954                 _ => panic!("Unexpected event"),
6955         }
6956
6957         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6958         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6959         if announce_latest {
6960                 mine_transaction(&nodes[0], &as_last_commitment_tx[0]);
6961         } else {
6962                 mine_transaction(&nodes[0], &as_prev_commitment_tx[0]);
6963         }
6964
6965         check_closed_broadcast!(nodes[0], true);
6966         check_added_monitors!(nodes[0], 1);
6967
6968         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6969         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
6970         let events = nodes[0].node.get_and_clear_pending_events();
6971         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6972         assert_eq!(events.len(), 2);
6973         let mut first_failed = false;
6974         for event in events {
6975                 match event {
6976                         Event::PaymentFailed { payment_hash, .. } => {
6977                                 if payment_hash == payment_hash_1 {
6978                                         assert!(!first_failed);
6979                                         first_failed = true;
6980                                 } else {
6981                                         assert_eq!(payment_hash, payment_hash_2);
6982                                 }
6983                         }
6984                         _ => panic!("Unexpected event"),
6985                 }
6986         }
6987 }
6988
6989 #[test]
6990 fn test_failure_delay_dust_htlc_local_commitment() {
6991         do_test_failure_delay_dust_htlc_local_commitment(true);
6992         do_test_failure_delay_dust_htlc_local_commitment(false);
6993 }
6994
6995 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6996         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6997         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6998         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6999         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7000         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7001         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7002
7003         let chanmon_cfgs = create_chanmon_cfgs(3);
7004         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7005         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7006         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7007         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7008
7009         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7010
7011         let (_payment_preimage_1, dust_hash, _payment_secret_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7012         let (_payment_preimage_2, non_dust_hash, _payment_secret_2) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7013
7014         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7015         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7016
7017         // We revoked bs_commitment_tx
7018         if revoked {
7019                 let (payment_preimage_3, _, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7020                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7021         }
7022
7023         let mut timeout_tx = Vec::new();
7024         if local {
7025                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7026                 mine_transaction(&nodes[0], &as_commitment_tx[0]);
7027                 check_closed_broadcast!(nodes[0], true);
7028                 check_added_monitors!(nodes[0], 1);
7029                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7030                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7031                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7032                 expect_payment_failed!(nodes[0], dust_hash, true);
7033                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7034                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7035                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7036                 mine_transaction(&nodes[0], &timeout_tx[0]);
7037                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7038                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7039         } else {
7040                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7041                 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
7042                 check_closed_broadcast!(nodes[0], true);
7043                 check_added_monitors!(nodes[0], 1);
7044                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7045                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7046                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7047                 if !revoked {
7048                         expect_payment_failed!(nodes[0], dust_hash, true);
7049                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7050                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7051                         mine_transaction(&nodes[0], &timeout_tx[0]);
7052                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7053                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7054                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7055                 } else {
7056                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7057                         // commitment tx
7058                         let events = nodes[0].node.get_and_clear_pending_events();
7059                         assert_eq!(events.len(), 2);
7060                         let first;
7061                         match events[0] {
7062                                 Event::PaymentFailed { payment_hash, .. } => {
7063                                         if payment_hash == dust_hash { first = true; }
7064                                         else { first = false; }
7065                                 },
7066                                 _ => panic!("Unexpected event"),
7067                         }
7068                         match events[1] {
7069                                 Event::PaymentFailed { payment_hash, .. } => {
7070                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7071                                         else { assert_eq!(payment_hash, dust_hash); }
7072                                 },
7073                                 _ => panic!("Unexpected event"),
7074                         }
7075                 }
7076         }
7077 }
7078
7079 #[test]
7080 fn test_sweep_outbound_htlc_failure_update() {
7081         do_test_sweep_outbound_htlc_failure_update(false, true);
7082         do_test_sweep_outbound_htlc_failure_update(false, false);
7083         do_test_sweep_outbound_htlc_failure_update(true, false);
7084 }
7085
7086 #[test]
7087 fn test_upfront_shutdown_script() {
7088         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7089         // enforce it at shutdown message
7090
7091         let mut config = UserConfig::default();
7092         config.channel_options.announced_channel = true;
7093         config.peer_channel_config_limits.force_announced_channel_preference = false;
7094         config.channel_options.commit_upfront_shutdown_pubkey = false;
7095         let user_cfgs = [None, Some(config), None];
7096         let chanmon_cfgs = create_chanmon_cfgs(3);
7097         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7098         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7099         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7100
7101         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7102         let flags = InitFeatures::known();
7103         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7104         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7105         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7106         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7107         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7108         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7109     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()));
7110         check_added_monitors!(nodes[2], 1);
7111
7112         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7113         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7114         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7115         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7116         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7117         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7118         let events = nodes[2].node.get_and_clear_pending_msg_events();
7119         assert_eq!(events.len(), 1);
7120         match events[0] {
7121                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7122                 _ => panic!("Unexpected event"),
7123         }
7124
7125         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7126         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7127         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7128         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7129         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7130         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7131         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &node_1_shutdown);
7132         let events = nodes[1].node.get_and_clear_pending_msg_events();
7133         assert_eq!(events.len(), 1);
7134         match events[0] {
7135                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7136                 _ => panic!("Unexpected event"),
7137         }
7138
7139         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7140         // channel smoothly, opt-out is from channel initiator here
7141         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7142         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7143         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7144         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7145         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7146         let events = nodes[0].node.get_and_clear_pending_msg_events();
7147         assert_eq!(events.len(), 1);
7148         match events[0] {
7149                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7150                 _ => panic!("Unexpected event"),
7151         }
7152
7153         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7154         //// channel smoothly
7155         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7156         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7157         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7158         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7159         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7160         let events = nodes[0].node.get_and_clear_pending_msg_events();
7161         assert_eq!(events.len(), 2);
7162         match events[0] {
7163                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7164                 _ => panic!("Unexpected event"),
7165         }
7166         match events[1] {
7167                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7168                 _ => panic!("Unexpected event"),
7169         }
7170 }
7171
7172 #[test]
7173 fn test_upfront_shutdown_script_unsupport_segwit() {
7174         // We test that channel is closed early
7175         // if a segwit program is passed as upfront shutdown script,
7176         // but the peer does not support segwit.
7177         let chanmon_cfgs = create_chanmon_cfgs(2);
7178         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7179         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7180         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7181
7182         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
7183
7184         let mut open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7185         open_channel.shutdown_scriptpubkey = Present(Builder::new().push_int(16)
7186                 .push_slice(&[0, 0])
7187                 .into_script());
7188
7189         let features = InitFeatures::known().clear_shutdown_anysegwit();
7190         nodes[0].node.handle_open_channel(&nodes[0].node.get_our_node_id(), features, &open_channel);
7191
7192         let events = nodes[0].node.get_and_clear_pending_msg_events();
7193         assert_eq!(events.len(), 1);
7194         match events[0] {
7195                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7196                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
7197                         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));
7198                 },
7199                 _ => panic!("Unexpected event"),
7200         }
7201 }
7202
7203 #[test]
7204 fn test_shutdown_script_any_segwit_allowed() {
7205         let mut config = UserConfig::default();
7206         config.channel_options.announced_channel = true;
7207         config.peer_channel_config_limits.force_announced_channel_preference = false;
7208         config.channel_options.commit_upfront_shutdown_pubkey = false;
7209         let user_cfgs = [None, Some(config), None];
7210         let chanmon_cfgs = create_chanmon_cfgs(3);
7211         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7212         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7213         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7214
7215         //// We test if the remote peer accepts opt_shutdown_anysegwit, a witness program can be used on shutdown
7216         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7217         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7218         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7219         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7220                 .push_slice(&[0, 0])
7221                 .into_script();
7222         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7223         let events = nodes[0].node.get_and_clear_pending_msg_events();
7224         assert_eq!(events.len(), 2);
7225         match events[0] {
7226                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7227                 _ => panic!("Unexpected event"),
7228         }
7229         match events[1] {
7230                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7231                 _ => panic!("Unexpected event"),
7232         }
7233 }
7234
7235 #[test]
7236 fn test_shutdown_script_any_segwit_not_allowed() {
7237         let mut config = UserConfig::default();
7238         config.channel_options.announced_channel = true;
7239         config.peer_channel_config_limits.force_announced_channel_preference = false;
7240         config.channel_options.commit_upfront_shutdown_pubkey = false;
7241         let user_cfgs = [None, Some(config), None];
7242         let chanmon_cfgs = create_chanmon_cfgs(3);
7243         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7244         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7245         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7246
7247         //// We test that if the remote peer does not accept opt_shutdown_anysegwit, the witness program cannot be used on shutdown
7248         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7249         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7250         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7251         // Make an any segwit version script
7252         node_0_shutdown.scriptpubkey = Builder::new().push_int(16)
7253                 .push_slice(&[0, 0])
7254                 .into_script();
7255         let flags_no = InitFeatures::known().clear_shutdown_anysegwit();
7256         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &flags_no, &node_0_shutdown);
7257         let events = nodes[0].node.get_and_clear_pending_msg_events();
7258         assert_eq!(events.len(), 2);
7259         match events[1] {
7260                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7261                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7262                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (60020000) from remote peer".to_owned())
7263                 },
7264                 _ => panic!("Unexpected event"),
7265         }
7266         check_added_monitors!(nodes[0], 1);
7267 }
7268
7269 #[test]
7270 fn test_shutdown_script_segwit_but_not_anysegwit() {
7271         let mut config = UserConfig::default();
7272         config.channel_options.announced_channel = true;
7273         config.peer_channel_config_limits.force_announced_channel_preference = false;
7274         config.channel_options.commit_upfront_shutdown_pubkey = false;
7275         let user_cfgs = [None, Some(config), None];
7276         let chanmon_cfgs = create_chanmon_cfgs(3);
7277         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7278         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7279         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7280
7281         //// We test that if shutdown any segwit is supported and we send a witness script with 0 version, this is not accepted
7282         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7283         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7284         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7285         // Make a segwit script that is not a valid as any segwit
7286         node_0_shutdown.scriptpubkey = Builder::new().push_int(0)
7287                 .push_slice(&[0, 0])
7288                 .into_script();
7289         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &node_0_shutdown);
7290         let events = nodes[0].node.get_and_clear_pending_msg_events();
7291         assert_eq!(events.len(), 2);
7292         match events[1] {
7293                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
7294                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7295                         assert_eq!(msg.data, "Got a nonstandard scriptpubkey (00020000) from remote peer".to_owned())
7296                 },
7297                 _ => panic!("Unexpected event"),
7298         }
7299         check_added_monitors!(nodes[0], 1);
7300 }
7301
7302 #[test]
7303 fn test_user_configurable_csv_delay() {
7304         // We test our channel constructors yield errors when we pass them absurd csv delay
7305
7306         let mut low_our_to_self_config = UserConfig::default();
7307         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7308         let mut high_their_to_self_config = UserConfig::default();
7309         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7310         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7311         let chanmon_cfgs = create_chanmon_cfgs(2);
7312         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7313         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7314         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7315
7316         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7317         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) {
7318                 match error {
7319                         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())); },
7320                         _ => panic!("Unexpected event"),
7321                 }
7322         } else { assert!(false) }
7323
7324         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7325         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7326         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7327         open_channel.to_self_delay = 200;
7328         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) {
7329                 match error {
7330                         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()));  },
7331                         _ => panic!("Unexpected event"),
7332                 }
7333         } else { assert!(false); }
7334
7335         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7336         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7337         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()));
7338         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7339         accept_channel.to_self_delay = 200;
7340         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7341         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7342                 match action {
7343                         &ErrorAction::SendErrorMessage { ref msg } => {
7344                                 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()));
7345                         },
7346                         _ => { assert!(false); }
7347                 }
7348         } else { assert!(false); }
7349
7350         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7351         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7352         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7353         open_channel.to_self_delay = 200;
7354         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) {
7355                 match error {
7356                         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())); },
7357                         _ => panic!("Unexpected event"),
7358                 }
7359         } else { assert!(false); }
7360 }
7361
7362 #[test]
7363 fn test_data_loss_protect() {
7364         // We want to be sure that :
7365         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7366         //   (but this is not quite true - we broadcast during Drop because chanmon is out of sync with chanmgr)
7367         // * we close channel in case of detecting other being fallen behind
7368         // * we are able to claim our own outputs thanks to to_remote being static
7369         // TODO: this test is incomplete and the data_loss_protect implementation is incomplete - see issue #775
7370         let persister;
7371         let logger;
7372         let fee_estimator;
7373         let tx_broadcaster;
7374         let chain_source;
7375         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7376         // We broadcast during Drop because chanmon is out of sync with chanmgr, which would cause a panic
7377         // during signing due to revoked tx
7378         chanmon_cfgs[0].keys_manager.disable_revocation_policy_check = true;
7379         let keys_manager = &chanmon_cfgs[0].keys_manager;
7380         let monitor;
7381         let node_state_0;
7382         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7383         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7384         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7385
7386         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7387
7388         // Cache node A state before any channel update
7389         let previous_node_state = nodes[0].node.encode();
7390         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7391         nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut previous_chain_monitor_state).unwrap();
7392
7393         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7394         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7395
7396         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7397         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7398
7399         // Restore node A from previous state
7400         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7401         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0), keys_manager).unwrap().1;
7402         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7403         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7404         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7405         persister = test_utils::TestPersister::new();
7406         monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &tx_broadcaster, &logger, &fee_estimator, &persister, keys_manager);
7407         node_state_0 = {
7408                 let mut channel_monitors = HashMap::new();
7409                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7410                 <(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 {
7411                         keys_manager: keys_manager,
7412                         fee_estimator: &fee_estimator,
7413                         chain_monitor: &monitor,
7414                         logger: &logger,
7415                         tx_broadcaster: &tx_broadcaster,
7416                         default_config: UserConfig::default(),
7417                         channel_monitors,
7418                 }).unwrap().1
7419         };
7420         nodes[0].node = &node_state_0;
7421         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7422         nodes[0].chain_monitor = &monitor;
7423         nodes[0].chain_source = &chain_source;
7424
7425         check_added_monitors!(nodes[0], 1);
7426
7427         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7428         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7429
7430         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7431
7432         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7433         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7434         check_added_monitors!(nodes[0], 1);
7435
7436         {
7437                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7438                 assert_eq!(node_txn.len(), 0);
7439         }
7440
7441         let mut reestablish_1 = Vec::with_capacity(1);
7442         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7443                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7444                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7445                         reestablish_1.push(msg.clone());
7446                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7447                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7448                         match action {
7449                                 &ErrorAction::SendErrorMessage { ref msg } => {
7450                                         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");
7451                                 },
7452                                 _ => panic!("Unexpected event!"),
7453                         }
7454                 } else {
7455                         panic!("Unexpected event")
7456                 }
7457         }
7458
7459         // Check we close channel detecting A is fallen-behind
7460         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7461         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7462         check_added_monitors!(nodes[1], 1);
7463
7464
7465         // Check A is able to claim to_remote output
7466         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7467         assert_eq!(node_txn.len(), 1);
7468         check_spends!(node_txn[0], chan.3);
7469         assert_eq!(node_txn[0].output.len(), 2);
7470         mine_transaction(&nodes[0], &node_txn[0]);
7471         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
7472         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 1000000);
7473         assert_eq!(spend_txn.len(), 1);
7474         check_spends!(spend_txn[0], node_txn[0]);
7475 }
7476
7477 #[test]
7478 fn test_check_htlc_underpaying() {
7479         // Send payment through A -> B but A is maliciously
7480         // sending a probe payment (i.e less than expected value0
7481         // to B, B should refuse payment.
7482
7483         let chanmon_cfgs = create_chanmon_cfgs(2);
7484         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7485         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7486         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7487
7488         // Create some initial channels
7489         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7490
7491         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7492
7493         // Node 3 is expecting payment of 100_000 but receive 10_000,
7494         // fail htlc like we didn't know the preimage.
7495         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7496         nodes[1].node.process_pending_htlc_forwards();
7497
7498         let events = nodes[1].node.get_and_clear_pending_msg_events();
7499         assert_eq!(events.len(), 1);
7500         let (update_fail_htlc, commitment_signed) = match events[0] {
7501                 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 } } => {
7502                         assert!(update_add_htlcs.is_empty());
7503                         assert!(update_fulfill_htlcs.is_empty());
7504                         assert_eq!(update_fail_htlcs.len(), 1);
7505                         assert!(update_fail_malformed_htlcs.is_empty());
7506                         assert!(update_fee.is_none());
7507                         (update_fail_htlcs[0].clone(), commitment_signed)
7508                 },
7509                 _ => panic!("Unexpected event"),
7510         };
7511         check_added_monitors!(nodes[1], 1);
7512
7513         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7514         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7515
7516         // 10_000 msat as u64, followed by a height of CHAN_CONFIRM_DEPTH as u32
7517         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7518         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(CHAN_CONFIRM_DEPTH));
7519         expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7520         nodes[1].node.get_and_clear_pending_events();
7521 }
7522
7523 #[test]
7524 fn test_announce_disable_channels() {
7525         // Create 2 channels between A and B. Disconnect B. Call timer_tick_occurred and check for generated
7526         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7527
7528         let chanmon_cfgs = create_chanmon_cfgs(2);
7529         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7530         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7531         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7532
7533         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7534         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7535         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7536
7537         // Disconnect peers
7538         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7539         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7540
7541         nodes[0].node.timer_tick_occurred(); // dirty -> stagged
7542         nodes[0].node.timer_tick_occurred(); // staged -> fresh
7543         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7544         assert_eq!(msg_events.len(), 3);
7545         for e in msg_events {
7546                 match e {
7547                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7548                                 let short_id = msg.contents.short_channel_id;
7549                                 // Check generated channel_update match list in PendingChannelUpdate
7550                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7551                                         panic!("Generated ChannelUpdate for wrong chan!");
7552                                 }
7553                         },
7554                         _ => panic!("Unexpected event"),
7555                 }
7556         }
7557         // Reconnect peers
7558         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7559         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7560         assert_eq!(reestablish_1.len(), 3);
7561         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7562         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7563         assert_eq!(reestablish_2.len(), 3);
7564
7565         // Reestablish chan_1
7566         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7567         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7568         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7569         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7570         // Reestablish chan_2
7571         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7572         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7573         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7574         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7575         // Reestablish chan_3
7576         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7577         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7578         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7579         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7580
7581         nodes[0].node.timer_tick_occurred();
7582         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7583 }
7584
7585 #[test]
7586 fn test_bump_penalty_txn_on_revoked_commitment() {
7587         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7588         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7589
7590         let chanmon_cfgs = create_chanmon_cfgs(2);
7591         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7592         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7593         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7594
7595         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7596         let logger = test_utils::TestLogger::new();
7597
7598         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7599         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7600         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();
7601         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7602
7603         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7604         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7605         assert_eq!(revoked_txn[0].output.len(), 4);
7606         assert_eq!(revoked_txn[0].input.len(), 1);
7607         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7608         let revoked_txid = revoked_txn[0].txid();
7609
7610         let mut penalty_sum = 0;
7611         for outp in revoked_txn[0].output.iter() {
7612                 if outp.script_pubkey.is_v0_p2wsh() {
7613                         penalty_sum += outp.value;
7614                 }
7615         }
7616
7617         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7618         let header_114 = connect_blocks(&nodes[1], 14);
7619
7620         // Actually revoke tx by claiming a HTLC
7621         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7622         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7623         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] });
7624         check_added_monitors!(nodes[1], 1);
7625
7626         // One or more justice tx should have been broadcast, check it
7627         let penalty_1;
7628         let feerate_1;
7629         {
7630                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7631                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7632                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7633                 assert_eq!(node_txn[0].output.len(), 1);
7634                 check_spends!(node_txn[0], revoked_txn[0]);
7635                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7636                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7637                 penalty_1 = node_txn[0].txid();
7638                 node_txn.clear();
7639         };
7640
7641         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7642         connect_blocks(&nodes[1], 15);
7643         let mut penalty_2 = penalty_1;
7644         let mut feerate_2 = 0;
7645         {
7646                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7647                 assert_eq!(node_txn.len(), 1);
7648                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
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                         penalty_2 = node_txn[0].txid();
7653                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7654                         assert_ne!(penalty_2, penalty_1);
7655                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7656                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7657                         // Verify 25% bump heuristic
7658                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7659                         node_txn.clear();
7660                 }
7661         }
7662         assert_ne!(feerate_2, 0);
7663
7664         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7665         connect_blocks(&nodes[1], 1);
7666         let penalty_3;
7667         let mut feerate_3 = 0;
7668         {
7669                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7670                 assert_eq!(node_txn.len(), 1);
7671                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7672                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7673                         assert_eq!(node_txn[0].output.len(), 1);
7674                         check_spends!(node_txn[0], revoked_txn[0]);
7675                         penalty_3 = node_txn[0].txid();
7676                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7677                         assert_ne!(penalty_3, penalty_2);
7678                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7679                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7680                         // Verify 25% bump heuristic
7681                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7682                         node_txn.clear();
7683                 }
7684         }
7685         assert_ne!(feerate_3, 0);
7686
7687         nodes[1].node.get_and_clear_pending_events();
7688         nodes[1].node.get_and_clear_pending_msg_events();
7689 }
7690
7691 #[test]
7692 fn test_bump_penalty_txn_on_revoked_htlcs() {
7693         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7694         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7695
7696         let mut chanmon_cfgs = create_chanmon_cfgs(2);
7697         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
7698         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7699         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7700         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7701
7702         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7703         // Lock HTLC in both directions
7704         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7705         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7706
7707         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7708         assert_eq!(revoked_local_txn[0].input.len(), 1);
7709         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7710
7711         // Revoke local commitment tx
7712         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7713
7714         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7715         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7716         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] });
7717         check_closed_broadcast!(nodes[1], true);
7718         check_added_monitors!(nodes[1], 1);
7719
7720         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7721         assert_eq!(revoked_htlc_txn.len(), 4);
7722         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7723                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7724                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7725                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7726                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7727                 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7728                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7729         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7730                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7731                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7732                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7733                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7734                 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7735                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7736         }
7737
7738         // Broadcast set of revoked txn on A
7739         let hash_128 = connect_blocks(&nodes[0], 40);
7740         let header_11 = BlockHeader { version: 0x20000000, prev_blockhash: hash_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7741         connect_block(&nodes[0], &Block { header: header_11, txdata: vec![revoked_local_txn[0].clone()] });
7742         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_11.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7743         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] });
7744         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7745         let first;
7746         let feerate_1;
7747         let penalty_txn;
7748         {
7749                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7750                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7751                 // Verify claim tx are spending revoked HTLC txn
7752
7753                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7754                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7755                 // which are included in the same block (they are broadcasted because we scan the
7756                 // transactions linearly and generate claims as we go, they likely should be removed in the
7757                 // future).
7758                 assert_eq!(node_txn[0].input.len(), 1);
7759                 check_spends!(node_txn[0], revoked_local_txn[0]);
7760                 assert_eq!(node_txn[1].input.len(), 1);
7761                 check_spends!(node_txn[1], revoked_local_txn[0]);
7762                 assert_eq!(node_txn[2].input.len(), 1);
7763                 check_spends!(node_txn[2], revoked_local_txn[0]);
7764
7765                 // Each of the three justice transactions claim a separate (single) output of the three
7766                 // available, which we check here:
7767                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7768                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7769                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7770
7771                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7772                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7773
7774                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7775                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7776                 // a remote commitment tx has already been confirmed).
7777                 check_spends!(node_txn[3], chan.3);
7778
7779                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7780                 // output, checked above).
7781                 assert_eq!(node_txn[4].input.len(), 2);
7782                 assert_eq!(node_txn[4].output.len(), 1);
7783                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7784
7785                 first = node_txn[4].txid();
7786                 // Store both feerates for later comparison
7787                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7788                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7789                 penalty_txn = vec![node_txn[2].clone()];
7790                 node_txn.clear();
7791         }
7792
7793         // Connect one more block to see if bumped penalty are issued for HTLC txn
7794         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7795         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
7796         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7797         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() });
7798         {
7799                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7800                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7801
7802                 check_spends!(node_txn[0], revoked_local_txn[0]);
7803                 check_spends!(node_txn[1], revoked_local_txn[0]);
7804                 // Note that these are both bogus - they spend outputs already claimed in block 129:
7805                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
7806                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7807                 } else {
7808                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7809                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7810                 }
7811
7812                 node_txn.clear();
7813         };
7814
7815         // Few more blocks to confirm penalty txn
7816         connect_blocks(&nodes[0], 4);
7817         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7818         let header_144 = connect_blocks(&nodes[0], 9);
7819         let node_txn = {
7820                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7821                 assert_eq!(node_txn.len(), 1);
7822
7823                 assert_eq!(node_txn[0].input.len(), 2);
7824                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7825                 // Verify bumped tx is different and 25% bump heuristic
7826                 assert_ne!(first, node_txn[0].txid());
7827                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7828                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7829                 assert!(feerate_2 * 100 > feerate_1 * 125);
7830                 let txn = vec![node_txn[0].clone()];
7831                 node_txn.clear();
7832                 txn
7833         };
7834         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7835         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7836         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn });
7837         connect_blocks(&nodes[0], 20);
7838         {
7839                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7840                 // We verify than no new transaction has been broadcast because previously
7841                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7842                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7843                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7844                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7845                 // up bumped justice generation.
7846                 assert_eq!(node_txn.len(), 0);
7847                 node_txn.clear();
7848         }
7849         check_closed_broadcast!(nodes[0], true);
7850         check_added_monitors!(nodes[0], 1);
7851 }
7852
7853 #[test]
7854 fn test_bump_penalty_txn_on_remote_commitment() {
7855         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7856         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7857
7858         // Create 2 HTLCs
7859         // Provide preimage for one
7860         // Check aggregation
7861
7862         let chanmon_cfgs = create_chanmon_cfgs(2);
7863         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7864         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7865         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7866
7867         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7868         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7869         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7870
7871         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7872         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7873         assert_eq!(remote_txn[0].output.len(), 4);
7874         assert_eq!(remote_txn[0].input.len(), 1);
7875         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7876
7877         // Claim a HTLC without revocation (provide B monitor with preimage)
7878         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7879         mine_transaction(&nodes[1], &remote_txn[0]);
7880         check_added_monitors!(nodes[1], 2);
7881
7882         // One or more claim tx should have been broadcast, check it
7883         let timeout;
7884         let preimage;
7885         let feerate_timeout;
7886         let feerate_preimage;
7887         {
7888                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7889                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7890                 assert_eq!(node_txn[0].input.len(), 1);
7891                 assert_eq!(node_txn[1].input.len(), 1);
7892                 check_spends!(node_txn[0], remote_txn[0]);
7893                 check_spends!(node_txn[1], remote_txn[0]);
7894                 check_spends!(node_txn[2], chan.3);
7895                 check_spends!(node_txn[3], node_txn[2]);
7896                 check_spends!(node_txn[4], node_txn[2]);
7897                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7898                         timeout = node_txn[0].txid();
7899                         let index = node_txn[0].input[0].previous_output.vout;
7900                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7901                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7902
7903                         preimage = node_txn[1].txid();
7904                         let index = node_txn[1].input[0].previous_output.vout;
7905                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7906                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7907                 } else {
7908                         timeout = node_txn[1].txid();
7909                         let index = node_txn[1].input[0].previous_output.vout;
7910                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7911                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7912
7913                         preimage = node_txn[0].txid();
7914                         let index = node_txn[0].input[0].previous_output.vout;
7915                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7916                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7917                 }
7918                 node_txn.clear();
7919         };
7920         assert_ne!(feerate_timeout, 0);
7921         assert_ne!(feerate_preimage, 0);
7922
7923         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7924         connect_blocks(&nodes[1], 15);
7925         {
7926                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7927                 assert_eq!(node_txn.len(), 2);
7928                 assert_eq!(node_txn[0].input.len(), 1);
7929                 assert_eq!(node_txn[1].input.len(), 1);
7930                 check_spends!(node_txn[0], remote_txn[0]);
7931                 check_spends!(node_txn[1], remote_txn[0]);
7932                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7933                         let index = node_txn[0].input[0].previous_output.vout;
7934                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7935                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7936                         assert!(new_feerate * 100 > feerate_timeout * 125);
7937                         assert_ne!(timeout, node_txn[0].txid());
7938
7939                         let index = node_txn[1].input[0].previous_output.vout;
7940                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7941                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7942                         assert!(new_feerate * 100 > feerate_preimage * 125);
7943                         assert_ne!(preimage, node_txn[1].txid());
7944                 } else {
7945                         let index = node_txn[1].input[0].previous_output.vout;
7946                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7947                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7948                         assert!(new_feerate * 100 > feerate_timeout * 125);
7949                         assert_ne!(timeout, node_txn[1].txid());
7950
7951                         let index = node_txn[0].input[0].previous_output.vout;
7952                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7953                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7954                         assert!(new_feerate * 100 > feerate_preimage * 125);
7955                         assert_ne!(preimage, node_txn[0].txid());
7956                 }
7957                 node_txn.clear();
7958         }
7959
7960         nodes[1].node.get_and_clear_pending_events();
7961         nodes[1].node.get_and_clear_pending_msg_events();
7962 }
7963
7964 #[test]
7965 fn test_counterparty_raa_skip_no_crash() {
7966         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7967         // commitment transaction, we would have happily carried on and provided them the next
7968         // commitment transaction based on one RAA forward. This would probably eventually have led to
7969         // channel closure, but it would not have resulted in funds loss. Still, our
7970         // EnforcingSigner would have paniced as it doesn't like jumps into the future. Here, we
7971         // check simply that the channel is closed in response to such an RAA, but don't check whether
7972         // we decide to punish our counterparty for revoking their funds (as we don't currently
7973         // implement that).
7974         let chanmon_cfgs = create_chanmon_cfgs(2);
7975         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7976         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7977         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7978         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
7979
7980         let mut guard = nodes[0].node.channel_state.lock().unwrap();
7981         let keys = &guard.by_id.get_mut(&channel_id).unwrap().get_signer();
7982         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7983         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
7984         // Must revoke without gaps
7985         keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1);
7986         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7987                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7988
7989         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7990                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7991         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7992         check_added_monitors!(nodes[1], 1);
7993 }
7994
7995 #[test]
7996 fn test_bump_txn_sanitize_tracking_maps() {
7997         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7998         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7999
8000         let chanmon_cfgs = create_chanmon_cfgs(2);
8001         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8002         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8003         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8004
8005         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8006         // Lock HTLC in both directions
8007         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8008         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8009
8010         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8011         assert_eq!(revoked_local_txn[0].input.len(), 1);
8012         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8013
8014         // Revoke local commitment tx
8015         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8016
8017         // Broadcast set of revoked txn on A
8018         connect_blocks(&nodes[0], 52 - CHAN_CONFIRM_DEPTH);
8019         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8020         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 0);
8021
8022         mine_transaction(&nodes[0], &revoked_local_txn[0]);
8023         check_closed_broadcast!(nodes[0], true);
8024         check_added_monitors!(nodes[0], 1);
8025         let penalty_txn = {
8026                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8027                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8028                 check_spends!(node_txn[0], revoked_local_txn[0]);
8029                 check_spends!(node_txn[1], revoked_local_txn[0]);
8030                 check_spends!(node_txn[2], revoked_local_txn[0]);
8031                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8032                 node_txn.clear();
8033                 penalty_txn
8034         };
8035         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8036         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
8037         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8038         {
8039                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8040                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8041                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
8042                         assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
8043                 }
8044         }
8045 }
8046
8047 #[test]
8048 fn test_override_channel_config() {
8049         let chanmon_cfgs = create_chanmon_cfgs(2);
8050         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8051         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8052         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8053
8054         // Node0 initiates a channel to node1 using the override config.
8055         let mut override_config = UserConfig::default();
8056         override_config.own_channel_config.our_to_self_delay = 200;
8057
8058         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8059
8060         // Assert the channel created by node0 is using the override config.
8061         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8062         assert_eq!(res.channel_flags, 0);
8063         assert_eq!(res.to_self_delay, 200);
8064 }
8065
8066 #[test]
8067 fn test_override_0msat_htlc_minimum() {
8068         let mut zero_config = UserConfig::default();
8069         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8070         let chanmon_cfgs = create_chanmon_cfgs(2);
8071         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8072         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8073         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8074
8075         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8076         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8077         assert_eq!(res.htlc_minimum_msat, 1);
8078
8079         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8080         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8081         assert_eq!(res.htlc_minimum_msat, 1);
8082 }
8083
8084 #[test]
8085 fn test_simple_mpp() {
8086         // Simple test of sending a multi-path payment.
8087         let chanmon_cfgs = create_chanmon_cfgs(4);
8088         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8089         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8090         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8091
8092         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8093         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8094         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8095         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8096         let logger = test_utils::TestLogger::new();
8097
8098         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[3]);
8099         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8100         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();
8101         let path = route.paths[0].clone();
8102         route.paths.push(path);
8103         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8104         route.paths[0][0].short_channel_id = chan_1_id;
8105         route.paths[0][1].short_channel_id = chan_3_id;
8106         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8107         route.paths[1][0].short_channel_id = chan_2_id;
8108         route.paths[1][1].short_channel_id = chan_4_id;
8109         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
8110         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, 200_000);
8111 }
8112
8113 #[test]
8114 fn test_update_err_monitor_lockdown() {
8115         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8116         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8117         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8118         //
8119         // This scenario may happen in a watchtower setup, where watchtower process a block height
8120         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8121         // commitment at same time.
8122
8123         let chanmon_cfgs = create_chanmon_cfgs(2);
8124         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8125         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8126         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8127
8128         // Create some initial channel
8129         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8130         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8131
8132         // Rebalance the network to generate htlc in the two directions
8133         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8134
8135         // Route a HTLC from node 0 to node 1 (but don't settle)
8136         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8137
8138         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8139         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8140         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8141         let persister = test_utils::TestPersister::new();
8142         let watchtower = {
8143                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8144                 let monitor = monitors.get(&outpoint).unwrap();
8145                 let mut w = test_utils::TestVecWriter(Vec::new());
8146                 monitor.write(&mut w).unwrap();
8147                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8148                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8149                 assert!(new_monitor == *monitor);
8150                 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);
8151                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8152                 watchtower
8153         };
8154         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8155         watchtower.chain_monitor.block_connected(&Block { header, txdata: vec![] }, 200);
8156
8157         // Try to update ChannelMonitor
8158         assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8159         check_added_monitors!(nodes[1], 1);
8160         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8161         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8162         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8163         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8164                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8165                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8166                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8167                 } else { assert!(false); }
8168         } else { assert!(false); };
8169         // Our local monitor is in-sync and hasn't processed yet timeout
8170         check_added_monitors!(nodes[0], 1);
8171         let events = nodes[0].node.get_and_clear_pending_events();
8172         assert_eq!(events.len(), 1);
8173 }
8174
8175 #[test]
8176 fn test_concurrent_monitor_claim() {
8177         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8178         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8179         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8180         // state N+1 confirms. Alice claims output from state N+1.
8181
8182         let chanmon_cfgs = create_chanmon_cfgs(2);
8183         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8184         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8185         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8186
8187         // Create some initial channel
8188         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8189         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8190
8191         // Rebalance the network to generate htlc in the two directions
8192         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8193
8194         // Route a HTLC from node 0 to node 1 (but don't settle)
8195         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8196
8197         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8198         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8199         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8200         let persister = test_utils::TestPersister::new();
8201         let watchtower_alice = {
8202                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8203                 let monitor = monitors.get(&outpoint).unwrap();
8204                 let mut w = test_utils::TestVecWriter(Vec::new());
8205                 monitor.write(&mut w).unwrap();
8206                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8207                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8208                 assert!(new_monitor == *monitor);
8209                 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);
8210                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8211                 watchtower
8212         };
8213         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8214         watchtower_alice.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8215
8216         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8217         {
8218                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8219                 assert_eq!(txn.len(), 2);
8220                 txn.clear();
8221         }
8222
8223         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8224         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
8225         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8226         let persister = test_utils::TestPersister::new();
8227         let watchtower_bob = {
8228                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap();
8229                 let monitor = monitors.get(&outpoint).unwrap();
8230                 let mut w = test_utils::TestVecWriter(Vec::new());
8231                 monitor.write(&mut w).unwrap();
8232                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
8233                                 &mut ::std::io::Cursor::new(&w.0), &test_utils::OnlyReadsKeysInterface {}).unwrap().1;
8234                 assert!(new_monitor == *monitor);
8235                 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);
8236                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8237                 watchtower
8238         };
8239         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8240         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8241
8242         // Route another payment to generate another update with still previous HTLC pending
8243         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[0]);
8244         {
8245                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8246                 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();
8247                 nodes[1].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8248         }
8249         check_added_monitors!(nodes[1], 1);
8250
8251         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8252         assert_eq!(updates.update_add_htlcs.len(), 1);
8253         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8254         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8255                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8256                         // Watchtower Alice should already have seen the block and reject the update
8257                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8258                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8259                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8260                 } else { assert!(false); }
8261         } else { assert!(false); };
8262         // Our local monitor is in-sync and hasn't processed yet timeout
8263         check_added_monitors!(nodes[0], 1);
8264
8265         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8266         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8267         watchtower_bob.chain_monitor.block_connected(&Block { header, txdata: vec![] }, CHAN_CONFIRM_DEPTH + 1 + TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS);
8268
8269         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8270         let bob_state_y;
8271         {
8272                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8273                 assert_eq!(txn.len(), 2);
8274                 bob_state_y = txn[0].clone();
8275                 txn.clear();
8276         };
8277
8278         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8279         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8280         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);
8281         {
8282                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8283                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8284                 // the onchain detection of the HTLC output
8285                 assert_eq!(htlc_txn.len(), 2);
8286                 check_spends!(htlc_txn[0], bob_state_y);
8287                 check_spends!(htlc_txn[1], bob_state_y);
8288         }
8289 }
8290
8291 #[test]
8292 fn test_pre_lockin_no_chan_closed_update() {
8293         // Test that if a peer closes a channel in response to a funding_created message we don't
8294         // generate a channel update (as the channel cannot appear on chain without a funding_signed
8295         // message).
8296         //
8297         // Doing so would imply a channel monitor update before the initial channel monitor
8298         // registration, violating our API guarantees.
8299         //
8300         // Previously, full_stack_target managed to hit this case by opening then closing a channel,
8301         // then opening a second channel with the same funding output as the first (which is not
8302         // rejected because the first channel does not exist in the ChannelManager) and closing it
8303         // before receiving funding_signed.
8304         let chanmon_cfgs = create_chanmon_cfgs(2);
8305         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8306         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8307         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8308
8309         // Create an initial channel
8310         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8311         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8312         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8313         let accept_chan_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8314         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_chan_msg);
8315
8316         // Move the first channel through the funding flow...
8317         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[0], 100000, 42);
8318
8319         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8320         check_added_monitors!(nodes[0], 0);
8321
8322         let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8323         let channel_id = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index }.to_channel_id();
8324         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id, data: "Hi".to_owned() });
8325         assert!(nodes[0].chain_monitor.added_monitors.lock().unwrap().is_empty());
8326 }
8327
8328 #[test]
8329 fn test_htlc_no_detection() {
8330         // This test is a mutation to underscore the detection logic bug we had
8331         // before #653. HTLC value routed is above the remaining balance, thus
8332         // inverting HTLC and `to_remote` output. HTLC will come second and
8333         // it wouldn't be seen by pre-#653 detection as we were enumerate()'ing
8334         // on a watched outputs vector (Vec<TxOut>) thus implicitly relying on
8335         // outputs order detection for correct spending children filtring.
8336
8337         let chanmon_cfgs = create_chanmon_cfgs(2);
8338         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8339         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8340         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8341
8342         // Create some initial channels
8343         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8344
8345         send_payment(&nodes[0], &vec!(&nodes[1])[..], 1_000_000, 1_000_000);
8346         let (_, our_payment_hash, _) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 2_000_000);
8347         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
8348         assert_eq!(local_txn[0].input.len(), 1);
8349         assert_eq!(local_txn[0].output.len(), 3);
8350         check_spends!(local_txn[0], chan_1.3);
8351
8352         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8353         let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[0].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8354         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] });
8355         // We deliberately connect the local tx twice as this should provoke a failure calling
8356         // this test before #653 fix.
8357         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);
8358         check_closed_broadcast!(nodes[0], true);
8359         check_added_monitors!(nodes[0], 1);
8360
8361         let htlc_timeout = {
8362                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8363                 assert_eq!(node_txn[0].input.len(), 1);
8364                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8365                 check_spends!(node_txn[0], local_txn[0]);
8366                 node_txn[0].clone()
8367         };
8368
8369         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8370         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] });
8371         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
8372         expect_payment_failed!(nodes[0], our_payment_hash, true);
8373 }
8374
8375 fn do_test_onchain_htlc_settlement_after_close(broadcast_alice: bool, go_onchain_before_fulfill: bool) {
8376         // If we route an HTLC, then learn the HTLC's preimage after the upstream channel has been
8377         // force-closed, we must claim that HTLC on-chain. (Given an HTLC forwarded from Alice --> Bob -->
8378         // Carol, Alice would be the upstream node, and Carol the downstream.)
8379         //
8380         // Steps of the test:
8381         // 1) Alice sends a HTLC to Carol through Bob.
8382         // 2) Carol doesn't settle the HTLC.
8383         // 3) If broadcast_alice is true, Alice force-closes her channel with Bob. Else Bob force closes.
8384         // Steps 4 and 5 may be reordered depending on go_onchain_before_fulfill.
8385         // 4) Bob sees the Alice's commitment on his chain or vice versa. An offered output is present
8386         //    but can't be claimed as Bob doesn't have yet knowledge of the preimage.
8387         // 5) Carol release the preimage to Bob off-chain.
8388         // 6) Bob claims the offered output on the broadcasted commitment.
8389         let chanmon_cfgs = create_chanmon_cfgs(3);
8390         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8391         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8392         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8393
8394         // Create some initial channels
8395         let chan_ab = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8396         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8397
8398         // Steps (1) and (2):
8399         // Send an HTLC Alice --> Bob --> Carol, but Carol doesn't settle the HTLC back.
8400         let (payment_preimage, _payment_hash, _payment_secret) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3_000_000);
8401
8402         // Check that Alice's commitment transaction now contains an output for this HTLC.
8403         let alice_txn = get_local_commitment_txn!(nodes[0], chan_ab.2);
8404         check_spends!(alice_txn[0], chan_ab.3);
8405         assert_eq!(alice_txn[0].output.len(), 2);
8406         check_spends!(alice_txn[1], alice_txn[0]); // 2nd transaction is a non-final HTLC-timeout
8407         assert_eq!(alice_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8408         assert_eq!(alice_txn.len(), 2);
8409
8410         // Steps (3) and (4):
8411         // If `go_onchain_before_fufill`, broadcast the relevant commitment transaction and check that Bob
8412         // responds by (1) broadcasting a channel update and (2) adding a new ChannelMonitor.
8413         let mut force_closing_node = 0; // Alice force-closes
8414         if !broadcast_alice { force_closing_node = 1; } // Bob force-closes
8415         nodes[force_closing_node].node.force_close_channel(&chan_ab.2).unwrap();
8416         check_closed_broadcast!(nodes[force_closing_node], true);
8417         check_added_monitors!(nodes[force_closing_node], 1);
8418         if go_onchain_before_fulfill {
8419                 let txn_to_broadcast = match broadcast_alice {
8420                         true => alice_txn.clone(),
8421                         false => get_local_commitment_txn!(nodes[1], chan_ab.2)
8422                 };
8423                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8424                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8425                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8426                 if broadcast_alice {
8427                         check_closed_broadcast!(nodes[1], true);
8428                         check_added_monitors!(nodes[1], 1);
8429                 }
8430                 assert_eq!(bob_txn.len(), 1);
8431                 check_spends!(bob_txn[0], chan_ab.3);
8432         }
8433
8434         // Step (5):
8435         // Carol then claims the funds and sends an update_fulfill message to Bob, and they go through the
8436         // process of removing the HTLC from their commitment transactions.
8437         assert!(nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000));
8438         check_added_monitors!(nodes[2], 1);
8439         let carol_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
8440         assert!(carol_updates.update_add_htlcs.is_empty());
8441         assert!(carol_updates.update_fail_htlcs.is_empty());
8442         assert!(carol_updates.update_fail_malformed_htlcs.is_empty());
8443         assert!(carol_updates.update_fee.is_none());
8444         assert_eq!(carol_updates.update_fulfill_htlcs.len(), 1);
8445
8446         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &carol_updates.update_fulfill_htlcs[0]);
8447         // If Alice broadcasted but Bob doesn't know yet, here he prepares to tell her about the preimage.
8448         if !go_onchain_before_fulfill && broadcast_alice {
8449                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8450                 assert_eq!(events.len(), 1);
8451                 match events[0] {
8452                         MessageSendEvent::UpdateHTLCs { ref node_id, .. } => {
8453                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8454                         },
8455                         _ => panic!("Unexpected event"),
8456                 };
8457         }
8458         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &carol_updates.commitment_signed);
8459         // One monitor update for the preimage to update the Bob<->Alice channel, one monitor update
8460         // Carol<->Bob's updated commitment transaction info.
8461         check_added_monitors!(nodes[1], 2);
8462
8463         let events = nodes[1].node.get_and_clear_pending_msg_events();
8464         assert_eq!(events.len(), 2);
8465         let bob_revocation = match events[0] {
8466                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8467                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8468                         (*msg).clone()
8469                 },
8470                 _ => panic!("Unexpected event"),
8471         };
8472         let bob_updates = match events[1] {
8473                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
8474                         assert_eq!(*node_id, nodes[2].node.get_our_node_id());
8475                         (*updates).clone()
8476                 },
8477                 _ => panic!("Unexpected event"),
8478         };
8479
8480         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bob_revocation);
8481         check_added_monitors!(nodes[2], 1);
8482         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bob_updates.commitment_signed);
8483         check_added_monitors!(nodes[2], 1);
8484
8485         let events = nodes[2].node.get_and_clear_pending_msg_events();
8486         assert_eq!(events.len(), 1);
8487         let carol_revocation = match events[0] {
8488                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
8489                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
8490                         (*msg).clone()
8491                 },
8492                 _ => panic!("Unexpected event"),
8493         };
8494         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &carol_revocation);
8495         check_added_monitors!(nodes[1], 1);
8496
8497         // If this test requires the force-closed channel to not be on-chain until after the fulfill,
8498         // here's where we put said channel's commitment tx on-chain.
8499         let mut txn_to_broadcast = alice_txn.clone();
8500         if !broadcast_alice { txn_to_broadcast = get_local_commitment_txn!(nodes[1], chan_ab.2); }
8501         if !go_onchain_before_fulfill {
8502                 let header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
8503                 connect_block(&nodes[1], &Block { header, txdata: vec![txn_to_broadcast[0].clone()]});
8504                 // If Bob was the one to force-close, he will have already passed these checks earlier.
8505                 if broadcast_alice {
8506                         check_closed_broadcast!(nodes[1], true);
8507                         check_added_monitors!(nodes[1], 1);
8508                 }
8509                 let mut bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8510                 if broadcast_alice {
8511                         // In `connect_block()`, the ChainMonitor and ChannelManager are separately notified about a
8512                         // new block being connected. The ChannelManager being notified triggers a monitor update,
8513                         // which triggers broadcasting our commitment tx and an HTLC-claiming tx. The ChainMonitor
8514                         // being notified triggers the HTLC-claiming tx redundantly, resulting in 3 total txs being
8515                         // broadcasted.
8516                         assert_eq!(bob_txn.len(), 3);
8517                         check_spends!(bob_txn[1], chan_ab.3);
8518                 } else {
8519                         assert_eq!(bob_txn.len(), 2);
8520                         check_spends!(bob_txn[0], chan_ab.3);
8521                 }
8522         }
8523
8524         // Step (6):
8525         // Finally, check that Bob broadcasted a preimage-claiming transaction for the HTLC output on the
8526         // broadcasted commitment transaction.
8527         {
8528                 let bob_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
8529                 if go_onchain_before_fulfill {
8530                         // Bob should now have an extra broadcasted tx, for the preimage-claiming transaction.
8531                         assert_eq!(bob_txn.len(), 2);
8532                 }
8533                 let script_weight = match broadcast_alice {
8534                         true => OFFERED_HTLC_SCRIPT_WEIGHT,
8535                         false => ACCEPTED_HTLC_SCRIPT_WEIGHT
8536                 };
8537                 // If Alice force-closed and Bob didn't receive her commitment transaction until after he
8538                 // received Carol's fulfill, he broadcasts the HTLC-output-claiming transaction first. Else if
8539                 // Bob force closed or if he found out about Alice's commitment tx before receiving Carol's
8540                 // fulfill, then he broadcasts the HTLC-output-claiming transaction second.
8541                 if broadcast_alice && !go_onchain_before_fulfill {
8542                         check_spends!(bob_txn[0], txn_to_broadcast[0]);
8543                         assert_eq!(bob_txn[0].input[0].witness.last().unwrap().len(), script_weight);
8544                 } else {
8545                         check_spends!(bob_txn[1], txn_to_broadcast[0]);
8546                         assert_eq!(bob_txn[1].input[0].witness.last().unwrap().len(), script_weight);
8547                 }
8548         }
8549 }
8550
8551 #[test]
8552 fn test_onchain_htlc_settlement_after_close() {
8553         do_test_onchain_htlc_settlement_after_close(true, true);
8554         do_test_onchain_htlc_settlement_after_close(false, true); // Technically redundant, but may as well
8555         do_test_onchain_htlc_settlement_after_close(true, false);
8556         do_test_onchain_htlc_settlement_after_close(false, false);
8557 }
8558
8559 #[test]
8560 fn test_duplicate_chan_id() {
8561         // Test that if a given peer tries to open a channel with the same channel_id as one that is
8562         // already open we reject it and keep the old channel.
8563         //
8564         // Previously, full_stack_target managed to figure out that if you tried to open two channels
8565         // with the same funding output (ie post-funding channel_id), we'd create a monitor update for
8566         // the existing channel when we detect the duplicate new channel, screwing up our monitor
8567         // updating logic for the existing channel.
8568         let chanmon_cfgs = create_chanmon_cfgs(2);
8569         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8570         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8571         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8572
8573         // Create an initial channel
8574         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8575         let mut open_chan_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8576         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8577         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()));
8578
8579         // Try to create a second channel with the same temporary_channel_id as the first and check
8580         // that it is rejected.
8581         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8582         {
8583                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8584                 assert_eq!(events.len(), 1);
8585                 match events[0] {
8586                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8587                                 // Technically, at this point, nodes[1] would be justified in thinking both the
8588                                 // first (valid) and second (invalid) channels are closed, given they both have
8589                                 // the same non-temporary channel_id. However, currently we do not, so we just
8590                                 // move forward with it.
8591                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8592                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8593                         },
8594                         _ => panic!("Unexpected event"),
8595                 }
8596         }
8597
8598         // Move the first channel through the funding flow...
8599         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
8600
8601         nodes[0].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
8602         check_added_monitors!(nodes[0], 0);
8603
8604         let mut funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8605         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8606         {
8607                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
8608                 assert_eq!(added_monitors.len(), 1);
8609                 assert_eq!(added_monitors[0].0, funding_output);
8610                 added_monitors.clear();
8611         }
8612         let funding_signed_msg = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8613
8614         let funding_outpoint = ::chain::transaction::OutPoint { txid: funding_created_msg.funding_txid, index: funding_created_msg.funding_output_index };
8615         let channel_id = funding_outpoint.to_channel_id();
8616
8617         // Now we have the first channel past funding_created (ie it has a txid-based channel_id, not a
8618         // temporary one).
8619
8620         // First try to open a second channel with a temporary channel id equal to the txid-based one.
8621         // Technically this is allowed by the spec, but we don't support it and there's little reason
8622         // to. Still, it shouldn't cause any other issues.
8623         open_chan_msg.temporary_channel_id = channel_id;
8624         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_msg);
8625         {
8626                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8627                 assert_eq!(events.len(), 1);
8628                 match events[0] {
8629                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8630                                 // Technically, at this point, nodes[1] would be justified in thinking both
8631                                 // channels are closed, but currently we do not, so we just move forward with it.
8632                                 assert_eq!(msg.channel_id, open_chan_msg.temporary_channel_id);
8633                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8634                         },
8635                         _ => panic!("Unexpected event"),
8636                 }
8637         }
8638
8639         // Now try to create a second channel which has a duplicate funding output.
8640         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
8641         let open_chan_2_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8642         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_chan_2_msg);
8643         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()));
8644         create_funding_transaction(&nodes[0], 100000, 42); // Get and check the FundingGenerationReady event
8645
8646         let funding_created = {
8647                 let mut a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
8648                 let mut as_chan = a_channel_lock.by_id.get_mut(&open_chan_2_msg.temporary_channel_id).unwrap();
8649                 let logger = test_utils::TestLogger::new();
8650                 as_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap()
8651         };
8652         check_added_monitors!(nodes[0], 0);
8653         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8654         // At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8655         // still needs to be cleared here.
8656         check_added_monitors!(nodes[1], 1);
8657
8658         // ...still, nodes[1] will reject the duplicate channel.
8659         {
8660                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8661                 assert_eq!(events.len(), 1);
8662                 match events[0] {
8663                         MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id } => {
8664                                 // Technically, at this point, nodes[1] would be justified in thinking both
8665                                 // channels are closed, but currently we do not, so we just move forward with it.
8666                                 assert_eq!(msg.channel_id, channel_id);
8667                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
8668                         },
8669                         _ => panic!("Unexpected event"),
8670                 }
8671         }
8672
8673         // finally, finish creating the original channel and send a payment over it to make sure
8674         // everything is functional.
8675         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed_msg);
8676         {
8677                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
8678                 assert_eq!(added_monitors.len(), 1);
8679                 assert_eq!(added_monitors[0].0, funding_output);
8680                 added_monitors.clear();
8681         }
8682
8683         let events_4 = nodes[0].node.get_and_clear_pending_events();
8684         assert_eq!(events_4.len(), 0);
8685         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8686         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].txid(), funding_output.txid);
8687
8688         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8689         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8690         update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &as_update, &bs_update);
8691         send_payment(&nodes[0], &[&nodes[1]], 8000000, 8_000_000);
8692 }
8693
8694 #[test]
8695 fn test_error_chans_closed() {
8696         // Test that we properly handle error messages, closing appropriate channels.
8697         //
8698         // Prior to #787 we'd allow a peer to make us force-close a channel we had with a different
8699         // peer. The "real" fix for that is to index channels with peers_ids, however in the mean time
8700         // we can test various edge cases around it to ensure we don't regress.
8701         let chanmon_cfgs = create_chanmon_cfgs(3);
8702         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8703         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8704         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8705
8706         // Create some initial channels
8707         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8708         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8709         let chan_3 = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8710
8711         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8712         assert_eq!(nodes[1].node.list_usable_channels().len(), 2);
8713         assert_eq!(nodes[2].node.list_usable_channels().len(), 1);
8714
8715         // Closing a channel from a different peer has no effect
8716         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_3.2, data: "ERR".to_owned() });
8717         assert_eq!(nodes[0].node.list_usable_channels().len(), 3);
8718
8719         // Closing one channel doesn't impact others
8720         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: chan_2.2, data: "ERR".to_owned() });
8721         check_added_monitors!(nodes[0], 1);
8722         check_closed_broadcast!(nodes[0], false);
8723         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
8724         assert_eq!(nodes[0].node.list_usable_channels().len(), 2);
8725         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);
8726         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);
8727
8728         // A null channel ID should close all channels
8729         let _chan_4 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 10001, InitFeatures::known(), InitFeatures::known());
8730         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msgs::ErrorMessage { channel_id: [0; 32], data: "ERR".to_owned() });
8731         check_added_monitors!(nodes[0], 2);
8732         let events = nodes[0].node.get_and_clear_pending_msg_events();
8733         assert_eq!(events.len(), 2);
8734         match events[0] {
8735                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8736                         assert_eq!(msg.contents.flags & 2, 2);
8737                 },
8738                 _ => panic!("Unexpected event"),
8739         }
8740         match events[1] {
8741                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8742                         assert_eq!(msg.contents.flags & 2, 2);
8743                 },
8744                 _ => panic!("Unexpected event"),
8745         }
8746         // Note that at this point users of a standard PeerHandler will end up calling
8747         // peer_disconnected with no_connection_possible set to false, duplicating the
8748         // close-all-channels logic. That's OK, we don't want to end up not force-closing channels for
8749         // users with their own peer handling logic. We duplicate the call here, however.
8750         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8751         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8752
8753         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), true);
8754         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
8755         assert!(nodes[0].node.list_usable_channels()[0].channel_id == chan_3.2);
8756 }
8757
8758 #[test]
8759 fn test_invalid_funding_tx() {
8760         // Test that we properly handle invalid funding transactions sent to us from a peer.
8761         //
8762         // Previously, all other major lightning implementations had failed to properly sanitize
8763         // funding transactions from their counterparties, leading to a multi-implementation critical
8764         // security vulnerability (though we always sanitized properly, we've previously had
8765         // un-released crashes in the sanitization process).
8766         let chanmon_cfgs = create_chanmon_cfgs(2);
8767         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8768         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8769         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8770
8771         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 10_000, 42, None).unwrap();
8772         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()));
8773         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()));
8774
8775         let (temporary_channel_id, mut tx, _) = create_funding_transaction(&nodes[0], 100_000, 42);
8776         for output in tx.output.iter_mut() {
8777                 // Make the confirmed funding transaction have a bogus script_pubkey
8778                 output.script_pubkey = bitcoin::Script::new();
8779         }
8780
8781         nodes[0].node.funding_transaction_generated_unchecked(&temporary_channel_id, tx.clone(), 0).unwrap();
8782         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()));
8783         check_added_monitors!(nodes[1], 1);
8784
8785         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()));
8786         check_added_monitors!(nodes[0], 1);
8787
8788         let events_1 = nodes[0].node.get_and_clear_pending_events();
8789         assert_eq!(events_1.len(), 0);
8790
8791         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
8792         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
8793         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
8794
8795         confirm_transaction_at(&nodes[1], &tx, 1);
8796         check_added_monitors!(nodes[1], 1);
8797         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
8798         assert_eq!(events_2.len(), 1);
8799         if let MessageSendEvent::HandleError { node_id, action } = &events_2[0] {
8800                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
8801                 if let msgs::ErrorAction::SendErrorMessage { msg } = action {
8802                         assert_eq!(msg.data, "funding tx had wrong script/value or output index");
8803                 } else { panic!(); }
8804         } else { panic!(); }
8805         assert_eq!(nodes[1].node.list_channels().len(), 0);
8806 }