_ 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::transaction::OutPoint;
  15 use chain::keysinterface::{ChannelKeys, KeysInterface, SpendableOutputDescriptor};
  16 use chain::chaininterface;
  17 use chain::chaininterface::{ChainListener, ChainWatchInterfaceUtil, BlockNotifier};
  18 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  19 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  20 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
  21 use ln::channelmonitor;
  22 use ln::channel::{Channel, ChannelError};
  23 use ln::{chan_utils, onion_utils};
  24 use routing::router::{Route, RouteHop, get_route};
  25 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  26 use ln::msgs;
  27 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction, OptionalField};
  28 use util::enforcing_trait_impls::EnforcingChannelKeys;
  29 use util::{byte_utils, test_utils};
  30 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  31 use util::errors::APIError;
  32 use util::ser::{Writeable, Writer, ReadableArgs, Readable};
  33 use util::config::UserConfig;
  34
  35 use bitcoin::util::hash::BitcoinHash;
  36 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  37 use bitcoin::hashes::HashEngine;
  38 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
  39 use bitcoin::util::bip143;
  40 use bitcoin::util::address::Address;
  41 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  42 use bitcoin::blockdata::block::{Block, BlockHeader};
  43 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
  44 use bitcoin::blockdata::script::{Builder, Script};
  45 use bitcoin::blockdata::opcodes;
  46 use bitcoin::blockdata::constants::genesis_block;
  47 use bitcoin::network::constants::Network;
  48
  49 use bitcoin::hashes::sha256::Hash as Sha256;
  50 use bitcoin::hashes::Hash;
  51
  52 use bitcoin::secp256k1::{Secp256k1, Message};
  53 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  54
  55 use regex;
  56
  57 use std::collections::{BTreeSet, HashMap, HashSet};
  58 use std::default::Default;
  59 use std::sync::{Arc, Mutex};
  60 use std::sync::atomic::Ordering;
  61 use std::{mem, io};
  62
  63 use ln::functional_test_utils::*;
  64 use ln::chan_utils::PreCalculatedTxCreationKeys;
  65
  66 #[test]
  67 fn test_insane_channel_opens() {
  68         // Stand up a network of 2 nodes
  69         let chanmon_cfgs = create_chanmon_cfgs(2);
  70         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  71         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  72         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  73
  74         // Instantiate channel parameters where we push the maximum msats given our
  75         // funding satoshis
  76         let channel_value_sat = 31337; // same as funding satoshis
  77         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_remote_channel_reserve_satoshis(channel_value_sat);
  78         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  79
  80         // Have node0 initiate a channel to node1 with aforementioned parameters
  81         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  82
  83         // Extract the channel open message from node0 to node1
  84         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  85
  86         // Test helper that asserts we get the correct error string given a mutator
  87         // that supposedly makes the channel open message insane
  88         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  89                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  90                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  91                 assert_eq!(msg_events.len(), 1);
  92                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  93                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  94                         match action {
  95                                 &ErrorAction::SendErrorMessage { .. } => {
  96                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  97                                 },
  98                                 _ => panic!("unexpected event!"),
  99                         }
 100                 } else { assert!(false); }
 101         };
 102
 103         use ln::channel::MAX_FUNDING_SATOSHIS;
 104         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 105
 106         // Test all mutations that would make the channel open message insane
 107         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 });
 108
 109         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 110
 111         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 });
 112
 113         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 114
 115         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 });
 116
 117         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 });
 118
 119         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 });
 120
 121         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 122
 123         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 124 }
 125
 126 #[test]
 127 fn test_async_inbound_update_fee() {
 128         let chanmon_cfgs = create_chanmon_cfgs(2);
 129         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 130         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 131         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 132         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 133         let logger = test_utils::TestLogger::new();
 134         let channel_id = chan.2;
 135
 136         // balancing
 137         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 138
 139         // A                                        B
 140         // update_fee                            ->
 141         // send (1) commitment_signed            -.
 142         //                                       <- update_add_htlc/commitment_signed
 143         // send (2) RAA (awaiting remote revoke) -.
 144         // (1) commitment_signed is delivered    ->
 145         //                                       .- send (3) RAA (awaiting remote revoke)
 146         // (2) RAA is delivered                  ->
 147         //                                       .- send (4) commitment_signed
 148         //                                       <- (3) RAA is delivered
 149         // send (5) commitment_signed            -.
 150         //                                       <- (4) commitment_signed is delivered
 151         // send (6) RAA                          -.
 152         // (5) commitment_signed is delivered    ->
 153         //                                       <- RAA
 154         // (6) RAA is delivered                  ->
 155
 156         // First nodes[0] generates an update_fee
 157         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 158         check_added_monitors!(nodes[0], 1);
 159
 160         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 161         assert_eq!(events_0.len(), 1);
 162         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 163                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 164                         (update_fee.as_ref(), commitment_signed)
 165                 },
 166                 _ => panic!("Unexpected event"),
 167         };
 168
 169         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 170
 171         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 172         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 173         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 174         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(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
 175         check_added_monitors!(nodes[1], 1);
 176
 177         let payment_event = {
 178                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 179                 assert_eq!(events_1.len(), 1);
 180                 SendEvent::from_event(events_1.remove(0))
 181         };
 182         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 183         assert_eq!(payment_event.msgs.len(), 1);
 184
 185         // ...now when the messages get delivered everyone should be happy
 186         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 187         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 188         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 189         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 190         check_added_monitors!(nodes[0], 1);
 191
 192         // deliver(1), generate (3):
 193         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 194         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 195         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 196         check_added_monitors!(nodes[1], 1);
 197
 198         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 199         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 200         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 201         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 202         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 203         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 204         assert!(bs_update.update_fee.is_none()); // (4)
 205         check_added_monitors!(nodes[1], 1);
 206
 207         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 208         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 209         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 210         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 211         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 212         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 213         assert!(as_update.update_fee.is_none()); // (5)
 214         check_added_monitors!(nodes[0], 1);
 215
 216         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 217         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 218         // only (6) so get_event_msg's assert(len == 1) passes
 219         check_added_monitors!(nodes[0], 1);
 220
 221         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 222         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 223         check_added_monitors!(nodes[1], 1);
 224
 225         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 226         check_added_monitors!(nodes[0], 1);
 227
 228         let events_2 = nodes[0].node.get_and_clear_pending_events();
 229         assert_eq!(events_2.len(), 1);
 230         match events_2[0] {
 231                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 232                 _ => panic!("Unexpected event"),
 233         }
 234
 235         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 236         check_added_monitors!(nodes[1], 1);
 237 }
 238
 239 #[test]
 240 fn test_update_fee_unordered_raa() {
 241         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 242         // crash in an earlier version of the update_fee patch)
 243         let chanmon_cfgs = create_chanmon_cfgs(2);
 244         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 245         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 246         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 247         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 248         let channel_id = chan.2;
 249         let logger = test_utils::TestLogger::new();
 250
 251         // balancing
 252         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 253
 254         // First nodes[0] generates an update_fee
 255         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 256         check_added_monitors!(nodes[0], 1);
 257
 258         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 259         assert_eq!(events_0.len(), 1);
 260         let update_msg = match events_0[0] { // (1)
 261                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 262                         update_fee.as_ref()
 263                 },
 264                 _ => panic!("Unexpected event"),
 265         };
 266
 267         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 268
 269         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 270         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 271         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 272         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(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap(), our_payment_hash, &None).unwrap();
 273         check_added_monitors!(nodes[1], 1);
 274
 275         let payment_event = {
 276                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 277                 assert_eq!(events_1.len(), 1);
 278                 SendEvent::from_event(events_1.remove(0))
 279         };
 280         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 281         assert_eq!(payment_event.msgs.len(), 1);
 282
 283         // ...now when the messages get delivered everyone should be happy
 284         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 285         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 286         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 287         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 288         check_added_monitors!(nodes[0], 1);
 289
 290         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 291         check_added_monitors!(nodes[1], 1);
 292
 293         // We can't continue, sadly, because our (1) now has a bogus signature
 294 }
 295
 296 #[test]
 297 fn test_multi_flight_update_fee() {
 298         let chanmon_cfgs = create_chanmon_cfgs(2);
 299         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 300         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 301         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 302         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 303         let channel_id = chan.2;
 304
 305         // A                                        B
 306         // update_fee/commitment_signed          ->
 307         //                                       .- send (1) RAA and (2) commitment_signed
 308         // update_fee (never committed)          ->
 309         // (3) update_fee                        ->
 310         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 311         // don't track which updates correspond to which revoke_and_ack responses so we're in
 312         // AwaitingRAA mode and will not generate the update_fee yet.
 313         //                                       <- (1) RAA delivered
 314         // (3) is generated and send (4) CS      -.
 315         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 316         // know the per_commitment_point to use for it.
 317         //                                       <- (2) commitment_signed delivered
 318         // revoke_and_ack                        ->
 319         //                                          B should send no response here
 320         // (4) commitment_signed delivered       ->
 321         //                                       <- RAA/commitment_signed delivered
 322         // revoke_and_ack                        ->
 323
 324         // First nodes[0] generates an update_fee
 325         let initial_feerate = get_feerate!(nodes[0], channel_id);
 326         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 327         check_added_monitors!(nodes[0], 1);
 328
 329         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 330         assert_eq!(events_0.len(), 1);
 331         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 332                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 333                         (update_fee.as_ref().unwrap(), commitment_signed)
 334                 },
 335                 _ => panic!("Unexpected event"),
 336         };
 337
 338         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 339         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 340         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 341         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 342         check_added_monitors!(nodes[1], 1);
 343
 344         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 345         // transaction:
 346         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 347         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 348         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 349
 350         // Create the (3) update_fee message that nodes[0] will generate before it does...
 351         let mut update_msg_2 = msgs::UpdateFee {
 352                 channel_id: update_msg_1.channel_id.clone(),
 353                 feerate_per_kw: (initial_feerate + 30) as u32,
 354         };
 355
 356         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 357
 358         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 359         // Deliver (3)
 360         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 361
 362         // Deliver (1), generating (3) and (4)
 363         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 364         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 365         check_added_monitors!(nodes[0], 1);
 366         assert!(as_second_update.update_add_htlcs.is_empty());
 367         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 368         assert!(as_second_update.update_fail_htlcs.is_empty());
 369         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 370         // Check that the update_fee newly generated matches what we delivered:
 371         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 372         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 373
 374         // Deliver (2) commitment_signed
 375         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 376         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 377         check_added_monitors!(nodes[0], 1);
 378         // No commitment_signed so get_event_msg's assert(len == 1) passes
 379
 380         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 381         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 382         check_added_monitors!(nodes[1], 1);
 383
 384         // Delever (4)
 385         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 386         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 387         check_added_monitors!(nodes[1], 1);
 388
 389         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 390         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 391         check_added_monitors!(nodes[0], 1);
 392
 393         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 394         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 395         // No commitment_signed so get_event_msg's assert(len == 1) passes
 396         check_added_monitors!(nodes[0], 1);
 397
 398         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 399         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 400         check_added_monitors!(nodes[1], 1);
 401 }
 402
 403 #[test]
 404 fn test_1_conf_open() {
 405         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 406         // tests that we properly send one in that case.
 407         let mut alice_config = UserConfig::default();
 408         alice_config.own_channel_config.minimum_depth = 1;
 409         alice_config.channel_options.announced_channel = true;
 410         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 411         let mut bob_config = UserConfig::default();
 412         bob_config.own_channel_config.minimum_depth = 1;
 413         bob_config.channel_options.announced_channel = true;
 414         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 415         let chanmon_cfgs = create_chanmon_cfgs(2);
 416         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 417         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 418         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 419
 420         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 421         assert!(nodes[0].chain_monitor.does_match_tx(&tx));
 422         assert!(nodes[1].chain_monitor.does_match_tx(&tx));
 423
 424         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 425         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version as usize; 1]);
 426         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()));
 427
 428         nodes[0].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version as usize; 1]);
 429         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 430         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 431
 432         for node in nodes {
 433                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 434                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 435                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 436         }
 437 }
 438
 439 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 440         // Previously, we had issues deserializing channels when we hadn't connected the first block
 441         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 442         // serialization round-trips and simply do steps towards opening a channel and then drop the
 443         // Node objects.
 444
 445         let chanmon_cfgs = create_chanmon_cfgs(2);
 446         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 447         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 448         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 449
 450         if steps & 0b1000_0000 != 0{
 451                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 452                 nodes[0].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 453                 nodes[1].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 454         }
 455
 456         if steps & 0x0f == 0 { return; }
 457         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 458         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 459
 460         if steps & 0x0f == 1 { return; }
 461         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 462         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 463
 464         if steps & 0x0f == 2 { return; }
 465         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 466
 467         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 468
 469         if steps & 0x0f == 3 { return; }
 470         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 471         check_added_monitors!(nodes[0], 0);
 472         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 473
 474         if steps & 0x0f == 4 { return; }
 475         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 476         {
 477                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
 478                 assert_eq!(added_monitors.len(), 1);
 479                 assert_eq!(added_monitors[0].0, funding_output);
 480                 added_monitors.clear();
 481         }
 482         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 483
 484         if steps & 0x0f == 5 { return; }
 485         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 486         {
 487                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 488                 assert_eq!(added_monitors.len(), 1);
 489                 assert_eq!(added_monitors[0].0, funding_output);
 490                 added_monitors.clear();
 491         }
 492
 493         let events_4 = nodes[0].node.get_and_clear_pending_events();
 494         assert_eq!(events_4.len(), 1);
 495         match events_4[0] {
 496                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 497                         assert_eq!(user_channel_id, 42);
 498                         assert_eq!(*funding_txo, funding_output);
 499                 },
 500                 _ => panic!("Unexpected event"),
 501         };
 502
 503         if steps & 0x0f == 6 { return; }
 504         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 505
 506         if steps & 0x0f == 7 { return; }
 507         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
 508         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 509 }
 510
 511 #[test]
 512 fn test_sanity_on_in_flight_opens() {
 513         do_test_sanity_on_in_flight_opens(0);
 514         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(1);
 516         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(2);
 518         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(3);
 520         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(4);
 522         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 523         do_test_sanity_on_in_flight_opens(5);
 524         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 525         do_test_sanity_on_in_flight_opens(6);
 526         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 527         do_test_sanity_on_in_flight_opens(7);
 528         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 529         do_test_sanity_on_in_flight_opens(8);
 530         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 531 }
 532
 533 #[test]
 534 fn test_update_fee_vanilla() {
 535         let chanmon_cfgs = create_chanmon_cfgs(2);
 536         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 537         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 538         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 539         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 540         let channel_id = chan.2;
 541
 542         let feerate = get_feerate!(nodes[0], channel_id);
 543         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 544         check_added_monitors!(nodes[0], 1);
 545
 546         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 547         assert_eq!(events_0.len(), 1);
 548         let (update_msg, commitment_signed) = match events_0[0] {
 549                         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 } } => {
 550                         (update_fee.as_ref(), commitment_signed)
 551                 },
 552                 _ => panic!("Unexpected event"),
 553         };
 554         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 555
 556         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 557         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 558         check_added_monitors!(nodes[1], 1);
 559
 560         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 561         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 562         check_added_monitors!(nodes[0], 1);
 563
 564         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 565         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 566         // No commitment_signed so get_event_msg's assert(len == 1) passes
 567         check_added_monitors!(nodes[0], 1);
 568
 569         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 570         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 571         check_added_monitors!(nodes[1], 1);
 572 }
 573
 574 #[test]
 575 fn test_update_fee_that_funder_cannot_afford() {
 576         let chanmon_cfgs = create_chanmon_cfgs(2);
 577         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 578         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 579         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 580         let channel_value = 1888;
 581         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 582         let channel_id = chan.2;
 583
 584         let feerate = 260;
 585         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 586         check_added_monitors!(nodes[0], 1);
 587         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 588
 589         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 590
 591         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 592
 593         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 594         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 595         {
 596                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 597
 598                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 599                 let num_htlcs = commitment_tx.output.len() - 2;
 600                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 601                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 602                 actual_fee = channel_value - actual_fee;
 603                 assert_eq!(total_fee, actual_fee);
 604         }
 605
 606         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 607         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 608         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 609         check_added_monitors!(nodes[0], 1);
 610
 611         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 612
 613         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 614
 615         //While producing the commitment_signed response after handling a received update_fee request the
 616         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 617         //Should produce and error.
 618         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 619         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 620         check_added_monitors!(nodes[1], 1);
 621         check_closed_broadcast!(nodes[1], true);
 622 }
 623
 624 #[test]
 625 fn test_update_fee_with_fundee_update_add_htlc() {
 626         let chanmon_cfgs = create_chanmon_cfgs(2);
 627         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 628         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 629         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 630         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 631         let channel_id = chan.2;
 632         let logger = test_utils::TestLogger::new();
 633
 634         // balancing
 635         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 636
 637         let feerate = get_feerate!(nodes[0], channel_id);
 638         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 639         check_added_monitors!(nodes[0], 1);
 640
 641         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 642         assert_eq!(events_0.len(), 1);
 643         let (update_msg, commitment_signed) = match events_0[0] {
 644                         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 } } => {
 645                         (update_fee.as_ref(), commitment_signed)
 646                 },
 647                 _ => panic!("Unexpected event"),
 648         };
 649         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 650         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 651         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 652         check_added_monitors!(nodes[1], 1);
 653
 654         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 655         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 656         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(), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
 657
 658         // nothing happens since node[1] is in AwaitingRemoteRevoke
 659         nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
 660         {
 661                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 662                 assert_eq!(added_monitors.len(), 0);
 663                 added_monitors.clear();
 664         }
 665         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 666         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 667         // node[1] has nothing to do
 668
 669         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 670         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 671         check_added_monitors!(nodes[0], 1);
 672
 673         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 674         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 675         // No commitment_signed so get_event_msg's assert(len == 1) passes
 676         check_added_monitors!(nodes[0], 1);
 677         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 678         check_added_monitors!(nodes[1], 1);
 679         // AwaitingRemoteRevoke ends here
 680
 681         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 682         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 683         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 684         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 685         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 686         assert_eq!(commitment_update.update_fee.is_none(), true);
 687
 688         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 689         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 690         check_added_monitors!(nodes[0], 1);
 691         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 692
 693         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 694         check_added_monitors!(nodes[1], 1);
 695         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 696
 697         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 698         check_added_monitors!(nodes[1], 1);
 699         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 700         // No commitment_signed so get_event_msg's assert(len == 1) passes
 701
 702         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 703         check_added_monitors!(nodes[0], 1);
 704         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 705
 706         expect_pending_htlcs_forwardable!(nodes[0]);
 707
 708         let events = nodes[0].node.get_and_clear_pending_events();
 709         assert_eq!(events.len(), 1);
 710         match events[0] {
 711                 Event::PaymentReceived { .. } => { },
 712                 _ => panic!("Unexpected event"),
 713         };
 714
 715         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 716
 717         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 718         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 719         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 720 }
 721
 722 #[test]
 723 fn test_update_fee() {
 724         let chanmon_cfgs = create_chanmon_cfgs(2);
 725         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 726         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 727         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 728         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 729         let channel_id = chan.2;
 730
 731         // A                                        B
 732         // (1) update_fee/commitment_signed      ->
 733         //                                       <- (2) revoke_and_ack
 734         //                                       .- send (3) commitment_signed
 735         // (4) update_fee/commitment_signed      ->
 736         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 737         //                                       <- (3) commitment_signed delivered
 738         // send (6) revoke_and_ack               -.
 739         //                                       <- (5) deliver revoke_and_ack
 740         // (6) deliver revoke_and_ack            ->
 741         //                                       .- send (7) commitment_signed in response to (4)
 742         //                                       <- (7) deliver commitment_signed
 743         // revoke_and_ack                        ->
 744
 745         // Create and deliver (1)...
 746         let feerate = get_feerate!(nodes[0], channel_id);
 747         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 748         check_added_monitors!(nodes[0], 1);
 749
 750         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 751         assert_eq!(events_0.len(), 1);
 752         let (update_msg, commitment_signed) = match events_0[0] {
 753                         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 } } => {
 754                         (update_fee.as_ref(), commitment_signed)
 755                 },
 756                 _ => panic!("Unexpected event"),
 757         };
 758         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 759
 760         // Generate (2) and (3):
 761         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 762         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 763         check_added_monitors!(nodes[1], 1);
 764
 765         // Deliver (2):
 766         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 767         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 768         check_added_monitors!(nodes[0], 1);
 769
 770         // Create and deliver (4)...
 771         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 772         check_added_monitors!(nodes[0], 1);
 773         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 774         assert_eq!(events_0.len(), 1);
 775         let (update_msg, commitment_signed) = match events_0[0] {
 776                         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 } } => {
 777                         (update_fee.as_ref(), commitment_signed)
 778                 },
 779                 _ => panic!("Unexpected event"),
 780         };
 781
 782         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 783         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 784         check_added_monitors!(nodes[1], 1);
 785         // ... creating (5)
 786         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 787         // No commitment_signed so get_event_msg's assert(len == 1) passes
 788
 789         // Handle (3), creating (6):
 790         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 791         check_added_monitors!(nodes[0], 1);
 792         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 793         // No commitment_signed so get_event_msg's assert(len == 1) passes
 794
 795         // Deliver (5):
 796         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 797         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 798         check_added_monitors!(nodes[0], 1);
 799
 800         // Deliver (6), creating (7):
 801         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 802         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 803         assert!(commitment_update.update_add_htlcs.is_empty());
 804         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 805         assert!(commitment_update.update_fail_htlcs.is_empty());
 806         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 807         assert!(commitment_update.update_fee.is_none());
 808         check_added_monitors!(nodes[1], 1);
 809
 810         // Deliver (7)
 811         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 812         check_added_monitors!(nodes[0], 1);
 813         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 814         // No commitment_signed so get_event_msg's assert(len == 1) passes
 815
 816         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 817         check_added_monitors!(nodes[1], 1);
 818         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 819
 820         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 821         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 822         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 823 }
 824
 825 #[test]
 826 fn pre_funding_lock_shutdown_test() {
 827         // Test sending a shutdown prior to funding_locked after funding generation
 828         let chanmon_cfgs = create_chanmon_cfgs(2);
 829         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 830         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 831         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 832         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 833         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 834         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 835         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 836
 837         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 838         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 839         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 840         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 841         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 842
 843         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 844         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 845         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 846         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 847         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 848         assert!(node_0_none.is_none());
 849
 850         assert!(nodes[0].node.list_channels().is_empty());
 851         assert!(nodes[1].node.list_channels().is_empty());
 852 }
 853
 854 #[test]
 855 fn updates_shutdown_wait() {
 856         // Test sending a shutdown with outstanding updates pending
 857         let chanmon_cfgs = create_chanmon_cfgs(3);
 858         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 859         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 860         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 861         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 862         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 863         let logger = test_utils::TestLogger::new();
 864
 865         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 866
 867         nodes[0].node.close_channel(&chan_1.2).unwrap();
 868         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 869         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 870         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 871         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 872
 873         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 874         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 875
 876         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 877
 878         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 879         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 880         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 881         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 882         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 883         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 884
 885         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 886         check_added_monitors!(nodes[2], 1);
 887         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 888         assert!(updates.update_add_htlcs.is_empty());
 889         assert!(updates.update_fail_htlcs.is_empty());
 890         assert!(updates.update_fail_malformed_htlcs.is_empty());
 891         assert!(updates.update_fee.is_none());
 892         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 893         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 894         check_added_monitors!(nodes[1], 1);
 895         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 896         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 897
 898         assert!(updates_2.update_add_htlcs.is_empty());
 899         assert!(updates_2.update_fail_htlcs.is_empty());
 900         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 901         assert!(updates_2.update_fee.is_none());
 902         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 903         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 904         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 905
 906         let events = nodes[0].node.get_and_clear_pending_events();
 907         assert_eq!(events.len(), 1);
 908         match events[0] {
 909                 Event::PaymentSent { ref payment_preimage } => {
 910                         assert_eq!(our_payment_preimage, *payment_preimage);
 911                 },
 912                 _ => panic!("Unexpected event"),
 913         }
 914
 915         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 916         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 917         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 918         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 919         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 920         assert!(node_0_none.is_none());
 921
 922         assert!(nodes[0].node.list_channels().is_empty());
 923
 924         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 925         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 926         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 927         assert!(nodes[1].node.list_channels().is_empty());
 928         assert!(nodes[2].node.list_channels().is_empty());
 929 }
 930
 931 #[test]
 932 fn htlc_fail_async_shutdown() {
 933         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 934         let chanmon_cfgs = create_chanmon_cfgs(3);
 935         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 936         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 937         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 938         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 939         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 940         let logger = test_utils::TestLogger::new();
 941
 942         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 943         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 944         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 945         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
 946         check_added_monitors!(nodes[0], 1);
 947         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 948         assert_eq!(updates.update_add_htlcs.len(), 1);
 949         assert!(updates.update_fulfill_htlcs.is_empty());
 950         assert!(updates.update_fail_htlcs.is_empty());
 951         assert!(updates.update_fail_malformed_htlcs.is_empty());
 952         assert!(updates.update_fee.is_none());
 953
 954         nodes[1].node.close_channel(&chan_1.2).unwrap();
 955         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 956         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 957         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 958
 959         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 960         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 961         check_added_monitors!(nodes[1], 1);
 962         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 963         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 964
 965         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 966         assert!(updates_2.update_add_htlcs.is_empty());
 967         assert!(updates_2.update_fulfill_htlcs.is_empty());
 968         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 969         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 970         assert!(updates_2.update_fee.is_none());
 971
 972         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 973         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 974
 975         expect_payment_failed!(nodes[0], our_payment_hash, false);
 976
 977         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 978         assert_eq!(msg_events.len(), 2);
 979         let node_0_closing_signed = match msg_events[0] {
 980                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 981                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 982                         (*msg).clone()
 983                 },
 984                 _ => panic!("Unexpected event"),
 985         };
 986         match msg_events[1] {
 987                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 988                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 989                 },
 990                 _ => panic!("Unexpected event"),
 991         }
 992
 993         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 994         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 995         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 996         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 997         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 998         assert!(node_0_none.is_none());
 999
1000         assert!(nodes[0].node.list_channels().is_empty());
1001
1002         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1003         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1004         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1005         assert!(nodes[1].node.list_channels().is_empty());
1006         assert!(nodes[2].node.list_channels().is_empty());
1007 }
1008
1009 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1010         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1011         // messages delivered prior to disconnect
1012         let chanmon_cfgs = create_chanmon_cfgs(3);
1013         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1014         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1015         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1016         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1017         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1018
1019         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1020
1021         nodes[1].node.close_channel(&chan_1.2).unwrap();
1022         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1023         if recv_count > 0 {
1024                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1025                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1026                 if recv_count > 1 {
1027                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1028                 }
1029         }
1030
1031         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1032         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1033
1034         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1035         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1036         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1037         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1038
1039         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1040         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1041         assert!(node_1_shutdown == node_1_2nd_shutdown);
1042
1043         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1044         let node_0_2nd_shutdown = if recv_count > 0 {
1045                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1046                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1047                 node_0_2nd_shutdown
1048         } else {
1049                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1050                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1051                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1052         };
1053         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1054
1055         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1056         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1057
1058         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1059         check_added_monitors!(nodes[2], 1);
1060         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1061         assert!(updates.update_add_htlcs.is_empty());
1062         assert!(updates.update_fail_htlcs.is_empty());
1063         assert!(updates.update_fail_malformed_htlcs.is_empty());
1064         assert!(updates.update_fee.is_none());
1065         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1066         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1067         check_added_monitors!(nodes[1], 1);
1068         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1069         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1070
1071         assert!(updates_2.update_add_htlcs.is_empty());
1072         assert!(updates_2.update_fail_htlcs.is_empty());
1073         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1074         assert!(updates_2.update_fee.is_none());
1075         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1076         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1077         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1078
1079         let events = nodes[0].node.get_and_clear_pending_events();
1080         assert_eq!(events.len(), 1);
1081         match events[0] {
1082                 Event::PaymentSent { ref payment_preimage } => {
1083                         assert_eq!(our_payment_preimage, *payment_preimage);
1084                 },
1085                 _ => panic!("Unexpected event"),
1086         }
1087
1088         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1089         if recv_count > 0 {
1090                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1091                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1092                 assert!(node_1_closing_signed.is_some());
1093         }
1094
1095         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1096         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1097
1098         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1099         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1100         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1101         if recv_count == 0 {
1102                 // If all closing_signeds weren't delivered we can just resume where we left off...
1103                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1104
1105                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1106                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1107                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1108
1109                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1110                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1111                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1112
1113                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1114                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1115
1116                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1117                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1118                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1119
1120                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1121                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1122                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1123                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1124                 assert!(node_0_none.is_none());
1125         } else {
1126                 // If one node, however, received + responded with an identical closing_signed we end
1127                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1128                 // There isn't really anything better we can do simply, but in the future we might
1129                 // explore storing a set of recently-closed channels that got disconnected during
1130                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1131                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1132                 // transaction.
1133                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1134
1135                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1136                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1137                 assert_eq!(msg_events.len(), 1);
1138                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1139                         match action {
1140                                 &ErrorAction::SendErrorMessage { ref msg } => {
1141                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1142                                         assert_eq!(msg.channel_id, chan_1.2);
1143                                 },
1144                                 _ => panic!("Unexpected event!"),
1145                         }
1146                 } else { panic!("Needed SendErrorMessage close"); }
1147
1148                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1149                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1150                 // closing_signed so we do it ourselves
1151                 check_closed_broadcast!(nodes[0], false);
1152                 check_added_monitors!(nodes[0], 1);
1153         }
1154
1155         assert!(nodes[0].node.list_channels().is_empty());
1156
1157         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1158         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1159         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1160         assert!(nodes[1].node.list_channels().is_empty());
1161         assert!(nodes[2].node.list_channels().is_empty());
1162 }
1163
1164 #[test]
1165 fn test_shutdown_rebroadcast() {
1166         do_test_shutdown_rebroadcast(0);
1167         do_test_shutdown_rebroadcast(1);
1168         do_test_shutdown_rebroadcast(2);
1169 }
1170
1171 #[test]
1172 fn fake_network_test() {
1173         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1174         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1175         let chanmon_cfgs = create_chanmon_cfgs(4);
1176         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1177         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1178         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1179
1180         // Create some initial channels
1181         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1182         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1183         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1184
1185         // Rebalance the network a bit by relaying one payment through all the channels...
1186         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1187         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1188         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1189         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1190
1191         // Send some more payments
1192         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1193         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1194         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1195
1196         // Test failure packets
1197         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1198         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1199
1200         // Add a new channel that skips 3
1201         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1202
1203         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1204         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1205         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1206         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1207         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1208         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1209         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1210
1211         // Do some rebalance loop payments, simultaneously
1212         let mut hops = Vec::with_capacity(3);
1213         hops.push(RouteHop {
1214                 pubkey: nodes[2].node.get_our_node_id(),
1215                 node_features: NodeFeatures::empty(),
1216                 short_channel_id: chan_2.0.contents.short_channel_id,
1217                 channel_features: ChannelFeatures::empty(),
1218                 fee_msat: 0,
1219                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1220         });
1221         hops.push(RouteHop {
1222                 pubkey: nodes[3].node.get_our_node_id(),
1223                 node_features: NodeFeatures::empty(),
1224                 short_channel_id: chan_3.0.contents.short_channel_id,
1225                 channel_features: ChannelFeatures::empty(),
1226                 fee_msat: 0,
1227                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1228         });
1229         hops.push(RouteHop {
1230                 pubkey: nodes[1].node.get_our_node_id(),
1231                 node_features: NodeFeatures::empty(),
1232                 short_channel_id: chan_4.0.contents.short_channel_id,
1233                 channel_features: ChannelFeatures::empty(),
1234                 fee_msat: 1000000,
1235                 cltv_expiry_delta: TEST_FINAL_CLTV,
1236         });
1237         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;
1238         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;
1239         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1240
1241         let mut hops = Vec::with_capacity(3);
1242         hops.push(RouteHop {
1243                 pubkey: nodes[3].node.get_our_node_id(),
1244                 node_features: NodeFeatures::empty(),
1245                 short_channel_id: chan_4.0.contents.short_channel_id,
1246                 channel_features: ChannelFeatures::empty(),
1247                 fee_msat: 0,
1248                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1249         });
1250         hops.push(RouteHop {
1251                 pubkey: nodes[2].node.get_our_node_id(),
1252                 node_features: NodeFeatures::empty(),
1253                 short_channel_id: chan_3.0.contents.short_channel_id,
1254                 channel_features: ChannelFeatures::empty(),
1255                 fee_msat: 0,
1256                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1257         });
1258         hops.push(RouteHop {
1259                 pubkey: nodes[1].node.get_our_node_id(),
1260                 node_features: NodeFeatures::empty(),
1261                 short_channel_id: chan_2.0.contents.short_channel_id,
1262                 channel_features: ChannelFeatures::empty(),
1263                 fee_msat: 1000000,
1264                 cltv_expiry_delta: TEST_FINAL_CLTV,
1265         });
1266         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;
1267         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;
1268         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1269
1270         // Claim the rebalances...
1271         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1272         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1273
1274         // Add a duplicate new channel from 2 to 4
1275         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1276
1277         // Send some payments across both channels
1278         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1279         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1280         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1281
1282
1283         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1284         let events = nodes[0].node.get_and_clear_pending_msg_events();
1285         assert_eq!(events.len(), 0);
1286         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);
1287
1288         //TODO: Test that routes work again here as we've been notified that the channel is full
1289
1290         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1291         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1292         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1293
1294         // Close down the channels...
1295         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1296         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1297         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1298         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1299         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1300 }
1301
1302 #[test]
1303 fn holding_cell_htlc_counting() {
1304         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1305         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1306         // commitment dance rounds.
1307         let chanmon_cfgs = create_chanmon_cfgs(3);
1308         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1309         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1310         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1311         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1312         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1313         let logger = test_utils::TestLogger::new();
1314
1315         let mut payments = Vec::new();
1316         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1317                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1318                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1319                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1320                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1321                 payments.push((payment_preimage, payment_hash));
1322         }
1323         check_added_monitors!(nodes[1], 1);
1324
1325         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1326         assert_eq!(events.len(), 1);
1327         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1328         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1329
1330         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1331         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1332         // another HTLC.
1333         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1334         {
1335                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1336                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1337                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1338                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1339                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1340                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1341         }
1342
1343         // This should also be true if we try to forward a payment.
1344         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1345         {
1346                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1347                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1348                 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1349                 check_added_monitors!(nodes[0], 1);
1350         }
1351
1352         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1353         assert_eq!(events.len(), 1);
1354         let payment_event = SendEvent::from_event(events.pop().unwrap());
1355         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1356
1357         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1358         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1359         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1360         // fails), the second will process the resulting failure and fail the HTLC backward.
1361         expect_pending_htlcs_forwardable!(nodes[1]);
1362         expect_pending_htlcs_forwardable!(nodes[1]);
1363         check_added_monitors!(nodes[1], 1);
1364
1365         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1366         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1367         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1368
1369         let events = nodes[0].node.get_and_clear_pending_msg_events();
1370         assert_eq!(events.len(), 1);
1371         match events[0] {
1372                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1373                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1374                 },
1375                 _ => panic!("Unexpected event"),
1376         }
1377
1378         expect_payment_failed!(nodes[0], payment_hash_2, false);
1379
1380         // Now forward all the pending HTLCs and claim them back
1381         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1382         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1383         check_added_monitors!(nodes[2], 1);
1384
1385         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1386         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1387         check_added_monitors!(nodes[1], 1);
1388         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1389
1390         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1391         check_added_monitors!(nodes[1], 1);
1392         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1393
1394         for ref update in as_updates.update_add_htlcs.iter() {
1395                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1396         }
1397         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1398         check_added_monitors!(nodes[2], 1);
1399         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1400         check_added_monitors!(nodes[2], 1);
1401         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1402
1403         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1404         check_added_monitors!(nodes[1], 1);
1405         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1406         check_added_monitors!(nodes[1], 1);
1407         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1408
1409         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1410         check_added_monitors!(nodes[2], 1);
1411
1412         expect_pending_htlcs_forwardable!(nodes[2]);
1413
1414         let events = nodes[2].node.get_and_clear_pending_events();
1415         assert_eq!(events.len(), payments.len());
1416         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1417                 match event {
1418                         &Event::PaymentReceived { ref payment_hash, .. } => {
1419                                 assert_eq!(*payment_hash, *hash);
1420                         },
1421                         _ => panic!("Unexpected event"),
1422                 };
1423         }
1424
1425         for (preimage, _) in payments.drain(..) {
1426                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1427         }
1428
1429         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1430 }
1431
1432 #[test]
1433 fn duplicate_htlc_test() {
1434         // Test that we accept duplicate payment_hash HTLCs across the network and that
1435         // claiming/failing them are all separate and don't affect each other
1436         let chanmon_cfgs = create_chanmon_cfgs(6);
1437         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1438         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1439         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1440
1441         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1442         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1443         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1444         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1445         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1446         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1447
1448         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1449
1450         *nodes[0].network_payment_count.borrow_mut() -= 1;
1451         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1452
1453         *nodes[0].network_payment_count.borrow_mut() -= 1;
1454         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1455
1456         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1457         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1458         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1459 }
1460
1461 #[test]
1462 fn test_duplicate_htlc_different_direction_onchain() {
1463         // Test that ChannelMonitor doesn't generate 2 preimage txn
1464         // when we have 2 HTLCs with same preimage that go across a node
1465         // in opposite directions.
1466         let chanmon_cfgs = create_chanmon_cfgs(2);
1467         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1468         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1469         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1470
1471         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1472         let logger = test_utils::TestLogger::new();
1473
1474         // balancing
1475         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1476
1477         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1478
1479         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1480         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(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1481         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1482
1483         // Provide preimage to node 0 by claiming payment
1484         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1485         check_added_monitors!(nodes[0], 1);
1486
1487         // Broadcast node 1 commitment txn
1488         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1489
1490         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1491         let mut has_both_htlcs = 0; // check htlcs match ones committed
1492         for outp in remote_txn[0].output.iter() {
1493                 if outp.value == 800_000 / 1000 {
1494                         has_both_htlcs += 1;
1495                 } else if outp.value == 900_000 / 1000 {
1496                         has_both_htlcs += 1;
1497                 }
1498         }
1499         assert_eq!(has_both_htlcs, 2);
1500
1501         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1502         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1503         check_added_monitors!(nodes[0], 1);
1504
1505         // Check we only broadcast 1 timeout tx
1506         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1507         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()) };
1508         assert_eq!(claim_txn.len(), 5);
1509         check_spends!(claim_txn[2], chan_1.3);
1510         check_spends!(claim_txn[3], claim_txn[2]);
1511         assert_eq!(htlc_pair.0.input.len(), 1);
1512         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1513         check_spends!(htlc_pair.0, remote_txn[0]);
1514         assert_eq!(htlc_pair.1.input.len(), 1);
1515         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1516         check_spends!(htlc_pair.1, remote_txn[0]);
1517
1518         let events = nodes[0].node.get_and_clear_pending_msg_events();
1519         assert_eq!(events.len(), 2);
1520         for e in events {
1521                 match e {
1522                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1523                         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, .. } } => {
1524                                 assert!(update_add_htlcs.is_empty());
1525                                 assert!(update_fail_htlcs.is_empty());
1526                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1527                                 assert!(update_fail_malformed_htlcs.is_empty());
1528                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1529                         },
1530                         _ => panic!("Unexpected event"),
1531                 }
1532         }
1533 }
1534
1535 #[test]
1536 fn test_basic_channel_reserve() {
1537         let chanmon_cfgs = create_chanmon_cfgs(2);
1538         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1539         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1540         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1541         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1542         let logger = test_utils::TestLogger::new();
1543
1544         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1545         let channel_reserve = chan_stat.channel_reserve_msat;
1546
1547         // The 2* and +1 are for the fee spike reserve.
1548         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1549         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1550         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1551         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1552         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(), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1553         let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1554         match err {
1555                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1556                         match &fails[0] {
1557                                 &APIError::ChannelUnavailable{ref err} =>
1558                                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)),
1559                                 _ => panic!("Unexpected error variant"),
1560                         }
1561                 },
1562                 _ => panic!("Unexpected error variant"),
1563         }
1564         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1565         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 1);
1566
1567         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1568 }
1569
1570 #[test]
1571 fn test_fee_spike_violation_fails_htlc() {
1572         let chanmon_cfgs = create_chanmon_cfgs(2);
1573         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1574         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1575         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1576         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1577         let logger = test_utils::TestLogger::new();
1578
1579         macro_rules! get_route_and_payment_hash {
1580                 ($recv_value: expr) => {{
1581                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1582                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
1583                         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1584                         (route, payment_hash, payment_preimage)
1585                 }}
1586         };
1587
1588         let (route, payment_hash, _) = get_route_and_payment_hash!(3460001);
1589         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1590         let secp_ctx = Secp256k1::new();
1591         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1592
1593         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1594
1595         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1596         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1597         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1598         let msg = msgs::UpdateAddHTLC {
1599                 channel_id: chan.2,
1600                 htlc_id: 0,
1601                 amount_msat: htlc_msat,
1602                 payment_hash: payment_hash,
1603                 cltv_expiry: htlc_cltv,
1604                 onion_routing_packet: onion_packet,
1605         };
1606
1607         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1608
1609         // Now manually create the commitment_signed message corresponding to the update_add
1610         // nodes[0] just sent. In the code for construction of this message, "local" refers
1611         // to the sender of the message, and "remote" refers to the receiver.
1612
1613         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1614
1615         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1616
1617         // Get the EnforcingChannelKeys for each channel, which will be used to (1) get the keys
1618         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1619         let (local_revocation_basepoint, local_htlc_basepoint, local_payment_point, local_secret, local_secret2) = {
1620                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1621                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1622                 let chan_keys = local_chan.get_local_keys();
1623                 let pubkeys = chan_keys.pubkeys();
1624                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1625                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER), chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2))
1626         };
1627         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_payment_point, remote_secret1) = {
1628                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1629                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1630                 let chan_keys = remote_chan.get_local_keys();
1631                 let pubkeys = chan_keys.pubkeys();
1632                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1633                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1))
1634         };
1635
1636         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1637         let commitment_secret = SecretKey::from_slice(&remote_secret1).unwrap();
1638         let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &commitment_secret);
1639         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, &remote_delayed_payment_basepoint,
1640                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1641
1642         // Build the remote commitment transaction so we can sign it, and then later use the
1643         // signature for the commitment_signed message.
1644         let local_chan_balance = 1313;
1645         let static_payment_pk = local_payment_point.serialize();
1646         let remote_commit_tx_output = TxOut {
1647                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1648                                                              .push_slice(&WPubkeyHash::hash(&static_payment_pk)[..])
1649                                                              .into_script(),
1650                 value: local_chan_balance as u64
1651         };
1652
1653         let local_commit_tx_output = TxOut {
1654                 script_pubkey: chan_utils::get_revokeable_redeemscript(&commit_tx_keys.revocation_key,
1655                                                                                BREAKDOWN_TIMEOUT,
1656                                                                                &commit_tx_keys.a_delayed_payment_key).to_v0_p2wsh(),
1657                                 value: 95000,
1658         };
1659
1660         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1661                 offered: false,
1662                 amount_msat: 3460001,
1663                 cltv_expiry: htlc_cltv,
1664                 payment_hash: payment_hash,
1665                 transaction_output_index: Some(1),
1666         };
1667
1668         let htlc_output = TxOut {
1669                 script_pubkey: chan_utils::get_htlc_redeemscript(&accepted_htlc_info, &commit_tx_keys).to_v0_p2wsh(),
1670                 value: 3460001 / 1000
1671         };
1672
1673         let commit_tx_obscure_factor = {
1674                 let mut sha = Sha256::engine();
1675                 let remote_payment_point = &remote_payment_point.serialize();
1676                 sha.input(&local_payment_point.serialize());
1677                 sha.input(remote_payment_point);
1678                 let res = Sha256::from_engine(sha).into_inner();
1679
1680                 ((res[26] as u64) << 5*8) |
1681                 ((res[27] as u64) << 4*8) |
1682                 ((res[28] as u64) << 3*8) |
1683                 ((res[29] as u64) << 2*8) |
1684                 ((res[30] as u64) << 1*8) |
1685                 ((res[31] as u64) << 0*8)
1686         };
1687         let commitment_number = 1;
1688         let obscured_commitment_transaction_number = commit_tx_obscure_factor ^ commitment_number;
1689         let lock_time = ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32);
1690         let input = TxIn {
1691                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
1692                 script_sig: Script::new(),
1693                 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
1694                 witness: Vec::new(),
1695         };
1696
1697         let commit_tx = Transaction {
1698                 version: 2,
1699                 lock_time,
1700                 input: vec![input],
1701                 output: vec![remote_commit_tx_output, htlc_output, local_commit_tx_output],
1702         };
1703         let res = {
1704                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1705                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1706                 let local_chan_keys = local_chan.get_local_keys();
1707                 let pre_commit_tx_keys = PreCalculatedTxCreationKeys::new(commit_tx_keys);
1708                 local_chan_keys.sign_remote_commitment(feerate_per_kw, &commit_tx, &pre_commit_tx_keys, &[&accepted_htlc_info], &secp_ctx).unwrap()
1709         };
1710
1711         let commit_signed_msg = msgs::CommitmentSigned {
1712                 channel_id: chan.2,
1713                 signature: res.0,
1714                 htlc_signatures: res.1
1715         };
1716
1717         // Send the commitment_signed message to the nodes[1].
1718         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1719         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1720
1721         // Send the RAA to nodes[1].
1722         let per_commitment_secret = local_secret;
1723         let next_secret = SecretKey::from_slice(&local_secret2).unwrap();
1724         let next_per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &next_secret);
1725         let raa_msg = msgs::RevokeAndACK{ channel_id: chan.2, per_commitment_secret, next_per_commitment_point};
1726         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1727
1728         let events = nodes[1].node.get_and_clear_pending_msg_events();
1729         assert_eq!(events.len(), 1);
1730         // Make sure the HTLC failed in the way we expect.
1731         match events[0] {
1732                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1733                         assert_eq!(update_fail_htlcs.len(), 1);
1734                         update_fail_htlcs[0].clone()
1735                 },
1736                 _ => panic!("Unexpected event"),
1737         };
1738         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1739
1740         check_added_monitors!(nodes[1], 2);
1741 }
1742
1743 #[test]
1744 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1745         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1746         // Set the fee rate for the channel very high, to the point where the fundee
1747         // sending any amount would result in a channel reserve violation. In this test
1748         // we check that we would be prevented from sending an HTLC in this situation.
1749         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1750         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1751         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1752         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1753         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1754         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1755         let logger = test_utils::TestLogger::new();
1756
1757         macro_rules! get_route_and_payment_hash {
1758                 ($recv_value: expr) => {{
1759                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1760                         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1761                         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.first().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1762                         (route, payment_hash, payment_preimage)
1763                 }}
1764         };
1765
1766         let (route, our_payment_hash, _) = get_route_and_payment_hash!(1000);
1767         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1768                 assert_eq!(err, "Cannot send value that would put them under remote channel reserve value"));
1769         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1770         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put them under remote channel reserve value".to_string(), 1);
1771 }
1772
1773 #[test]
1774 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1775         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1776         // Set the fee rate for the channel very high, to the point where the funder
1777         // receiving 1 update_add_htlc would result in them closing the channel due
1778         // to channel reserve violation. This close could also happen if the fee went
1779         // up a more realistic amount, but many HTLCs were outstanding at the time of
1780         // the update_add_htlc.
1781         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1782         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1783         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1784         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1785         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1786         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1787         let logger = test_utils::TestLogger::new();
1788
1789         macro_rules! get_route_and_payment_hash {
1790                 ($recv_value: expr) => {{
1791                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1792                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1793                         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.first().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1794                         (route, payment_hash, payment_preimage)
1795                 }}
1796         };
1797
1798         let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1799         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1800         let secp_ctx = Secp256k1::new();
1801         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1802         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1803         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1804         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1805         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1806         let msg = msgs::UpdateAddHTLC {
1807                 channel_id: chan.2,
1808                 htlc_id: 1,
1809                 amount_msat: htlc_msat + 1,
1810                 payment_hash: payment_hash,
1811                 cltv_expiry: htlc_cltv,
1812                 onion_routing_packet: onion_packet,
1813         };
1814
1815         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1816         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1817         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot receive value that would put us under local channel reserve value".to_string(), 1);
1818         assert_eq!(nodes[0].node.list_channels().len(), 0);
1819         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1820         assert_eq!(err_msg.data, "Cannot receive value that would put us under local channel reserve value");
1821         check_added_monitors!(nodes[0], 1);
1822 }
1823
1824 #[test]
1825 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1826         let chanmon_cfgs = create_chanmon_cfgs(3);
1827         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1828         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1829         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1830         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1831         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1832         let logger = test_utils::TestLogger::new();
1833
1834         macro_rules! get_route_and_payment_hash {
1835                 ($recv_value: expr) => {{
1836                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1837                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1838                         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(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1839                         (route, payment_hash, payment_preimage)
1840                 }}
1841         };
1842
1843         let feemsat = 239;
1844         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1845         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1846         let feerate = get_feerate!(nodes[0], chan.2);
1847
1848         // Add a 2* and +1 for the fee spike reserve.
1849         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1850         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;
1851         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1852
1853         // Add a pending HTLC.
1854         let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1855         let payment_event_1 = {
1856                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1857                 check_added_monitors!(nodes[0], 1);
1858
1859                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1860                 assert_eq!(events.len(), 1);
1861                 SendEvent::from_event(events.remove(0))
1862         };
1863         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1864
1865         // Attempt to trigger a channel reserve violation --> payment failure.
1866         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1867         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;
1868         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1869         let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1870
1871         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1872         let secp_ctx = Secp256k1::new();
1873         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1874         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1875         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1876         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1877         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1878         let msg = msgs::UpdateAddHTLC {
1879                 channel_id: chan.2,
1880                 htlc_id: 1,
1881                 amount_msat: htlc_msat + 1,
1882                 payment_hash: our_payment_hash_1,
1883                 cltv_expiry: htlc_cltv,
1884                 onion_routing_packet: onion_packet,
1885         };
1886
1887         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1888         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1889         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1890         assert_eq!(nodes[1].node.list_channels().len(), 1);
1891         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1892         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1893         check_added_monitors!(nodes[1], 1);
1894 }
1895
1896 #[test]
1897 fn test_inbound_outbound_capacity_is_not_zero() {
1898         let chanmon_cfgs = create_chanmon_cfgs(2);
1899         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1900         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1901         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1902         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1903         let channels0 = node_chanmgrs[0].list_channels();
1904         let channels1 = node_chanmgrs[1].list_channels();
1905         assert_eq!(channels0.len(), 1);
1906         assert_eq!(channels1.len(), 1);
1907
1908         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1909         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1910
1911         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1912         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1913 }
1914
1915 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1916         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1917 }
1918
1919 #[test]
1920 fn test_channel_reserve_holding_cell_htlcs() {
1921         let chanmon_cfgs = create_chanmon_cfgs(3);
1922         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1923         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1924         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1925         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1926         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1927         let logger = test_utils::TestLogger::new();
1928
1929         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1930         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1931
1932         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1933         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1934
1935         macro_rules! get_route_and_payment_hash {
1936                 ($recv_value: expr) => {{
1937                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1938                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1939                         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(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1940                         (route, payment_hash, payment_preimage)
1941                 }}
1942         };
1943
1944         macro_rules! expect_forward {
1945                 ($node: expr) => {{
1946                         let mut events = $node.node.get_and_clear_pending_msg_events();
1947                         assert_eq!(events.len(), 1);
1948                         check_added_monitors!($node, 1);
1949                         let payment_event = SendEvent::from_event(events.remove(0));
1950                         payment_event
1951                 }}
1952         }
1953
1954         let feemsat = 239; // somehow we know?
1955         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1956         let feerate = get_feerate!(nodes[0], chan_1.2);
1957
1958         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1959
1960         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1961         {
1962                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1963                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1964                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1965                         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)));
1966                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1967                 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);
1968         }
1969
1970         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1971         // nodes[0]'s wealth
1972         loop {
1973                 let amt_msat = recv_value_0 + total_fee_msat;
1974                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1975                 // Also, ensure that each payment has enough to be over the dust limit to
1976                 // ensure it'll be included in each commit tx fee calculation.
1977                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1978                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.their_dust_limit_msat + 1000);
1979                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1980                         break;
1981                 }
1982                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1983
1984                 let (stat01_, stat11_, stat12_, stat22_) = (
1985                         get_channel_value_stat!(nodes[0], chan_1.2),
1986                         get_channel_value_stat!(nodes[1], chan_1.2),
1987                         get_channel_value_stat!(nodes[1], chan_2.2),
1988                         get_channel_value_stat!(nodes[2], chan_2.2),
1989                 );
1990
1991                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1992                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1993                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1994                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1995                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1996         }
1997
1998         // adding pending output.
1999         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
2000         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
2001         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
2002         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
2003         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
2004         // cases where 1 msat over X amount will cause a payment failure, but anything less than
2005         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
2006         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
2007         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
2008         // policy.
2009         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
2010         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
2011         let amt_msat_1 = recv_value_1 + total_fee_msat;
2012
2013         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
2014         let payment_event_1 = {
2015                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
2016                 check_added_monitors!(nodes[0], 1);
2017
2018                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2019                 assert_eq!(events.len(), 1);
2020                 SendEvent::from_event(events.remove(0))
2021         };
2022         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
2023
2024         // channel reserve test with htlc pending output > 0
2025         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2026         {
2027                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
2028                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2029                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)));
2030                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2031         }
2032
2033         // split the rest to test holding cell
2034         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2035         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2036         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2037         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2038         {
2039                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2040                 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);
2041         }
2042
2043         // now see if they go through on both sides
2044         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2045         // but this will stuck in the holding cell
2046         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2047         check_added_monitors!(nodes[0], 0);
2048         let events = nodes[0].node.get_and_clear_pending_events();
2049         assert_eq!(events.len(), 0);
2050
2051         // test with outbound holding cell amount > 0
2052         {
2053                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2054                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2055                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)));
2056                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2057                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 2);
2058         }
2059
2060         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2061         // this will also stuck in the holding cell
2062         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2063         check_added_monitors!(nodes[0], 0);
2064         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2065         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2066
2067         // flush the pending htlc
2068         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2069         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2070         check_added_monitors!(nodes[1], 1);
2071
2072         // the pending htlc should be promoted to committed
2073         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2074         check_added_monitors!(nodes[0], 1);
2075         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2076
2077         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2078         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2079         // No commitment_signed so get_event_msg's assert(len == 1) passes
2080         check_added_monitors!(nodes[0], 1);
2081
2082         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2083         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2084         check_added_monitors!(nodes[1], 1);
2085
2086         expect_pending_htlcs_forwardable!(nodes[1]);
2087
2088         let ref payment_event_11 = expect_forward!(nodes[1]);
2089         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2090         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2091
2092         expect_pending_htlcs_forwardable!(nodes[2]);
2093         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2094
2095         // flush the htlcs in the holding cell
2096         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2097         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2098         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2099         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2100         expect_pending_htlcs_forwardable!(nodes[1]);
2101
2102         let ref payment_event_3 = expect_forward!(nodes[1]);
2103         assert_eq!(payment_event_3.msgs.len(), 2);
2104         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2105         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2106
2107         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2108         expect_pending_htlcs_forwardable!(nodes[2]);
2109
2110         let events = nodes[2].node.get_and_clear_pending_events();
2111         assert_eq!(events.len(), 2);
2112         match events[0] {
2113                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2114                         assert_eq!(our_payment_hash_21, *payment_hash);
2115                         assert_eq!(*payment_secret, None);
2116                         assert_eq!(recv_value_21, amt);
2117                 },
2118                 _ => panic!("Unexpected event"),
2119         }
2120         match events[1] {
2121                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2122                         assert_eq!(our_payment_hash_22, *payment_hash);
2123                         assert_eq!(None, *payment_secret);
2124                         assert_eq!(recv_value_22, amt);
2125                 },
2126                 _ => panic!("Unexpected event"),
2127         }
2128
2129         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2130         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2131         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2132
2133         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2134         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2135         {
2136                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_3 + 1);
2137                 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
2138                 match err {
2139                         PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
2140                                 match &fails[0] {
2141                                         &APIError::ChannelUnavailable{ref err} =>
2142                                                 assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)),
2143                                         _ => panic!("Unexpected error variant"),
2144                                 }
2145                         },
2146                         _ => panic!("Unexpected error variant"),
2147                 }
2148                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2149                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 3);
2150         }
2151
2152         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2153
2154         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2155         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);
2156         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2157         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2158         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2159
2160         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2161         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2162 }
2163
2164 #[test]
2165 fn channel_reserve_in_flight_removes() {
2166         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2167         // can send to its counterparty, but due to update ordering, the other side may not yet have
2168         // considered those HTLCs fully removed.
2169         // This tests that we don't count HTLCs which will not be included in the next remote
2170         // commitment transaction towards the reserve value (as it implies no commitment transaction
2171         // will be generated which violates the remote reserve value).
2172         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2173         // To test this we:
2174         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2175         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2176         //    you only consider the value of the first HTLC, it may not),
2177         //  * start routing a third HTLC from A to B,
2178         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2179         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2180         //  * deliver the first fulfill from B
2181         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2182         //    claim,
2183         //  * deliver A's response CS and RAA.
2184         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2185         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2186         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2187         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2188         let chanmon_cfgs = create_chanmon_cfgs(2);
2189         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2190         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2191         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2192         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2193         let logger = test_utils::TestLogger::new();
2194
2195         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2196         // Route the first two HTLCs.
2197         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2198         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2199
2200         // Start routing the third HTLC (this is just used to get everyone in the right state).
2201         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2202         let send_1 = {
2203                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2204                 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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
2205                 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2206                 check_added_monitors!(nodes[0], 1);
2207                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2208                 assert_eq!(events.len(), 1);
2209                 SendEvent::from_event(events.remove(0))
2210         };
2211
2212         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2213         // initial fulfill/CS.
2214         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2215         check_added_monitors!(nodes[1], 1);
2216         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2217
2218         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2219         // remove the second HTLC when we send the HTLC back from B to A.
2220         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2221         check_added_monitors!(nodes[1], 1);
2222         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2223
2224         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2225         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2226         check_added_monitors!(nodes[0], 1);
2227         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2228         expect_payment_sent!(nodes[0], payment_preimage_1);
2229
2230         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2231         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2232         check_added_monitors!(nodes[1], 1);
2233         // B is already AwaitingRAA, so cant generate a CS here
2234         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2235
2236         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2237         check_added_monitors!(nodes[1], 1);
2238         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2239
2240         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2241         check_added_monitors!(nodes[0], 1);
2242         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2243
2244         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2245         check_added_monitors!(nodes[1], 1);
2246         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2247
2248         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2249         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2250         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2251         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2252         // on-chain as necessary).
2253         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2254         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2255         check_added_monitors!(nodes[0], 1);
2256         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2257         expect_payment_sent!(nodes[0], payment_preimage_2);
2258
2259         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2260         check_added_monitors!(nodes[1], 1);
2261         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2262
2263         expect_pending_htlcs_forwardable!(nodes[1]);
2264         expect_payment_received!(nodes[1], payment_hash_3, 100000);
2265
2266         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2267         // resolve the second HTLC from A's point of view.
2268         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2269         check_added_monitors!(nodes[0], 1);
2270         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2271
2272         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2273         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2274         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2275         let send_2 = {
2276                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2277                 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(), None, &[], 10000, TEST_FINAL_CLTV, &logger).unwrap();
2278                 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2279                 check_added_monitors!(nodes[1], 1);
2280                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2281                 assert_eq!(events.len(), 1);
2282                 SendEvent::from_event(events.remove(0))
2283         };
2284
2285         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2286         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2287         check_added_monitors!(nodes[0], 1);
2288         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2289
2290         // Now just resolve all the outstanding messages/HTLCs for completeness...
2291
2292         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2293         check_added_monitors!(nodes[1], 1);
2294         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2295
2296         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2297         check_added_monitors!(nodes[1], 1);
2298
2299         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2300         check_added_monitors!(nodes[0], 1);
2301         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2302
2303         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2304         check_added_monitors!(nodes[1], 1);
2305         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2306
2307         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2308         check_added_monitors!(nodes[0], 1);
2309
2310         expect_pending_htlcs_forwardable!(nodes[0]);
2311         expect_payment_received!(nodes[0], payment_hash_4, 10000);
2312
2313         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2314         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2315 }
2316
2317 #[test]
2318 fn channel_monitor_network_test() {
2319         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2320         // tests that ChannelMonitor is able to recover from various states.
2321         let chanmon_cfgs = create_chanmon_cfgs(5);
2322         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2323         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2324         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2325
2326         // Create some initial channels
2327         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2328         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2329         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2330         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2331
2332         // Rebalance the network a bit by relaying one payment through all the channels...
2333         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2334         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2335         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2336         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2337
2338         // Simple case with no pending HTLCs:
2339         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2340         check_added_monitors!(nodes[1], 1);
2341         {
2342                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2343                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2344                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2345                 check_added_monitors!(nodes[0], 1);
2346                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2347         }
2348         get_announce_close_broadcast_events(&nodes, 0, 1);
2349         assert_eq!(nodes[0].node.list_channels().len(), 0);
2350         assert_eq!(nodes[1].node.list_channels().len(), 1);
2351
2352         // One pending HTLC is discarded by the force-close:
2353         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2354
2355         // Simple case of one pending HTLC to HTLC-Timeout
2356         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2357         check_added_monitors!(nodes[1], 1);
2358         {
2359                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2360                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2361                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2362                 check_added_monitors!(nodes[2], 1);
2363                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2364         }
2365         get_announce_close_broadcast_events(&nodes, 1, 2);
2366         assert_eq!(nodes[1].node.list_channels().len(), 0);
2367         assert_eq!(nodes[2].node.list_channels().len(), 1);
2368
2369         macro_rules! claim_funds {
2370                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2371                         {
2372                                 assert!($node.node.claim_funds($preimage, &None, $amount));
2373                                 check_added_monitors!($node, 1);
2374
2375                                 let events = $node.node.get_and_clear_pending_msg_events();
2376                                 assert_eq!(events.len(), 1);
2377                                 match events[0] {
2378                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2379                                                 assert!(update_add_htlcs.is_empty());
2380                                                 assert!(update_fail_htlcs.is_empty());
2381                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2382                                         },
2383                                         _ => panic!("Unexpected event"),
2384                                 };
2385                         }
2386                 }
2387         }
2388
2389         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2390         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2391         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2392         check_added_monitors!(nodes[2], 1);
2393         let node2_commitment_txid;
2394         {
2395                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2396                 node2_commitment_txid = node_txn[0].txid();
2397
2398                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2399                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2400
2401                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2402                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2403                 check_added_monitors!(nodes[3], 1);
2404
2405                 check_preimage_claim(&nodes[3], &node_txn);
2406         }
2407         get_announce_close_broadcast_events(&nodes, 2, 3);
2408         assert_eq!(nodes[2].node.list_channels().len(), 0);
2409         assert_eq!(nodes[3].node.list_channels().len(), 1);
2410
2411         { // Cheat and reset nodes[4]'s height to 1
2412                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2413                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2414         }
2415
2416         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2417         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2418         // One pending HTLC to time out:
2419         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2420         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2421         // buffer space).
2422
2423         let (close_chan_update_1, close_chan_update_2) = {
2424                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2425                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2426                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2427                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2428                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2429                 }
2430                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2431                 assert_eq!(events.len(), 1);
2432                 let close_chan_update_1 = match events[0] {
2433                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2434                                 msg.clone()
2435                         },
2436                         _ => panic!("Unexpected event"),
2437                 };
2438                 check_added_monitors!(nodes[3], 1);
2439
2440                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2441                 {
2442                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2443                         node_txn.retain(|tx| {
2444                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2445                                         false
2446                                 } else { true }
2447                         });
2448                 }
2449
2450                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2451
2452                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2453                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2454
2455                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2456
2457                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2458                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2459                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2460                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2461                 }
2462                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2463                 assert_eq!(events.len(), 1);
2464                 let close_chan_update_2 = match events[0] {
2465                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2466                                 msg.clone()
2467                         },
2468                         _ => panic!("Unexpected event"),
2469                 };
2470                 check_added_monitors!(nodes[4], 1);
2471                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2472
2473                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2474                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2475
2476                 check_preimage_claim(&nodes[4], &node_txn);
2477                 (close_chan_update_1, close_chan_update_2)
2478         };
2479         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2480         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2481         assert_eq!(nodes[3].node.list_channels().len(), 0);
2482         assert_eq!(nodes[4].node.list_channels().len(), 0);
2483 }
2484
2485 #[test]
2486 fn test_justice_tx() {
2487         // Test justice txn built on revoked HTLC-Success tx, against both sides
2488         let mut alice_config = UserConfig::default();
2489         alice_config.channel_options.announced_channel = true;
2490         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2491         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2492         let mut bob_config = UserConfig::default();
2493         bob_config.channel_options.announced_channel = true;
2494         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2495         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2496         let user_cfgs = [Some(alice_config), Some(bob_config)];
2497         let chanmon_cfgs = create_chanmon_cfgs(2);
2498         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2499         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2500         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2501         // Create some new channels:
2502         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2503
2504         // A pending HTLC which will be revoked:
2505         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2506         // Get the will-be-revoked local txn from nodes[0]
2507         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2508         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2509         assert_eq!(revoked_local_txn[0].input.len(), 1);
2510         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2511         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2512         assert_eq!(revoked_local_txn[1].input.len(), 1);
2513         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2514         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2515         // Revoke the old state
2516         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2517
2518         {
2519                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2520                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2521                 {
2522                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2523                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2524                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2525
2526                         check_spends!(node_txn[0], revoked_local_txn[0]);
2527                         node_txn.swap_remove(0);
2528                         node_txn.truncate(1);
2529                 }
2530                 check_added_monitors!(nodes[1], 1);
2531                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2532
2533                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2534                 // Verify broadcast of revoked HTLC-timeout
2535                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2536                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2537                 check_added_monitors!(nodes[0], 1);
2538                 // Broadcast revoked HTLC-timeout on node 1
2539                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2540                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2541         }
2542         get_announce_close_broadcast_events(&nodes, 0, 1);
2543
2544         assert_eq!(nodes[0].node.list_channels().len(), 0);
2545         assert_eq!(nodes[1].node.list_channels().len(), 0);
2546
2547         // We test justice_tx build by A on B's revoked HTLC-Success tx
2548         // Create some new channels:
2549         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2550         {
2551                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2552                 node_txn.clear();
2553         }
2554
2555         // A pending HTLC which will be revoked:
2556         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2557         // Get the will-be-revoked local txn from B
2558         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2559         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2560         assert_eq!(revoked_local_txn[0].input.len(), 1);
2561         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2562         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2563         // Revoke the old state
2564         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2565         {
2566                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2567                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2568                 {
2569                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2570                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2571                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2572
2573                         check_spends!(node_txn[0], revoked_local_txn[0]);
2574                         node_txn.swap_remove(0);
2575                 }
2576                 check_added_monitors!(nodes[0], 1);
2577                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2578
2579                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2580                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2581                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2582                 check_added_monitors!(nodes[1], 1);
2583                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2584                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2585         }
2586         get_announce_close_broadcast_events(&nodes, 0, 1);
2587         assert_eq!(nodes[0].node.list_channels().len(), 0);
2588         assert_eq!(nodes[1].node.list_channels().len(), 0);
2589 }
2590
2591 #[test]
2592 fn revoked_output_claim() {
2593         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2594         // transaction is broadcast by its counterparty
2595         let chanmon_cfgs = create_chanmon_cfgs(2);
2596         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2597         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2598         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2599         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2600         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2601         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2602         assert_eq!(revoked_local_txn.len(), 1);
2603         // Only output is the full channel value back to nodes[0]:
2604         assert_eq!(revoked_local_txn[0].output.len(), 1);
2605         // Send a payment through, updating everyone's latest commitment txn
2606         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2607
2608         // Inform nodes[1] that nodes[0] broadcast a stale tx
2609         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2610         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2611         check_added_monitors!(nodes[1], 1);
2612         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2613         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2614
2615         check_spends!(node_txn[0], revoked_local_txn[0]);
2616         check_spends!(node_txn[1], chan_1.3);
2617
2618         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2619         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2620         get_announce_close_broadcast_events(&nodes, 0, 1);
2621         check_added_monitors!(nodes[0], 1)
2622 }
2623
2624 #[test]
2625 fn claim_htlc_outputs_shared_tx() {
2626         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2627         let chanmon_cfgs = create_chanmon_cfgs(2);
2628         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2629         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2630         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2631
2632         // Create some new channel:
2633         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2634
2635         // Rebalance the network to generate htlc in the two directions
2636         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2637         // 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
2638         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2639         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2640
2641         // Get the will-be-revoked local txn from node[0]
2642         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2643         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2644         assert_eq!(revoked_local_txn[0].input.len(), 1);
2645         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2646         assert_eq!(revoked_local_txn[1].input.len(), 1);
2647         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2648         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2649         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2650
2651         //Revoke the old state
2652         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2653
2654         {
2655                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2656                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2657                 check_added_monitors!(nodes[0], 1);
2658                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2659                 check_added_monitors!(nodes[1], 1);
2660                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2661                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2662
2663                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2664                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2665
2666                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2667                 check_spends!(node_txn[0], revoked_local_txn[0]);
2668
2669                 let mut witness_lens = BTreeSet::new();
2670                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2671                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2672                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2673                 assert_eq!(witness_lens.len(), 3);
2674                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2675                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2676                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2677
2678                 // Next nodes[1] broadcasts its current local tx state:
2679                 assert_eq!(node_txn[1].input.len(), 1);
2680                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2681
2682                 assert_eq!(node_txn[2].input.len(), 1);
2683                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2684                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2685                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2686                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2687                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2688         }
2689         get_announce_close_broadcast_events(&nodes, 0, 1);
2690         assert_eq!(nodes[0].node.list_channels().len(), 0);
2691         assert_eq!(nodes[1].node.list_channels().len(), 0);
2692 }
2693
2694 #[test]
2695 fn claim_htlc_outputs_single_tx() {
2696         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2697         let chanmon_cfgs = create_chanmon_cfgs(2);
2698         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2699         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2700         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2701
2702         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2703
2704         // Rebalance the network to generate htlc in the two directions
2705         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2706         // 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
2707         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2708         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2709         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2710
2711         // Get the will-be-revoked local txn from node[0]
2712         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2713
2714         //Revoke the old state
2715         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2716
2717         {
2718                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2719                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2720                 check_added_monitors!(nodes[0], 1);
2721                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2722                 check_added_monitors!(nodes[1], 1);
2723                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2724
2725                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2726                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2727
2728                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2729                 assert_eq!(node_txn.len(), 9);
2730                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2731                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2732                 // 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)
2733                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2734
2735                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2736                 assert_eq!(node_txn[2].input.len(), 1);
2737                 check_spends!(node_txn[2], chan_1.3);
2738                 assert_eq!(node_txn[3].input.len(), 1);
2739                 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2740                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2741                 check_spends!(node_txn[3], node_txn[2]);
2742
2743                 // Justice transactions are indices 1-2-4
2744                 assert_eq!(node_txn[0].input.len(), 1);
2745                 assert_eq!(node_txn[1].input.len(), 1);
2746                 assert_eq!(node_txn[4].input.len(), 1);
2747
2748                 check_spends!(node_txn[0], revoked_local_txn[0]);
2749                 check_spends!(node_txn[1], revoked_local_txn[0]);
2750                 check_spends!(node_txn[4], revoked_local_txn[0]);
2751
2752                 let mut witness_lens = BTreeSet::new();
2753                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2754                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2755                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2756                 assert_eq!(witness_lens.len(), 3);
2757                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2758                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2759                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2760         }
2761         get_announce_close_broadcast_events(&nodes, 0, 1);
2762         assert_eq!(nodes[0].node.list_channels().len(), 0);
2763         assert_eq!(nodes[1].node.list_channels().len(), 0);
2764 }
2765
2766 #[test]
2767 fn test_htlc_on_chain_success() {
2768         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2769         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2770         // broadcasting the right event to other nodes in payment path.
2771         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2772         // A --------------------> B ----------------------> C (preimage)
2773         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2774         // commitment transaction was broadcast.
2775         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2776         // towards B.
2777         // B should be able to claim via preimage if A then broadcasts its local tx.
2778         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2779         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2780         // PaymentSent event).
2781
2782         let chanmon_cfgs = create_chanmon_cfgs(3);
2783         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2784         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2785         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2786
2787         // Create some initial channels
2788         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2789         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2790
2791         // Rebalance the network a bit by relaying one payment through all the channels...
2792         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2793         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2794
2795         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2796         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2797         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2798
2799         // Broadcast legit commitment tx from C on B's chain
2800         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2801         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2802         assert_eq!(commitment_tx.len(), 1);
2803         check_spends!(commitment_tx[0], chan_2.3);
2804         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2805         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2806         check_added_monitors!(nodes[2], 2);
2807         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2808         assert!(updates.update_add_htlcs.is_empty());
2809         assert!(updates.update_fail_htlcs.is_empty());
2810         assert!(updates.update_fail_malformed_htlcs.is_empty());
2811         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2812
2813         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2814         check_closed_broadcast!(nodes[2], false);
2815         check_added_monitors!(nodes[2], 1);
2816         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)
2817         assert_eq!(node_txn.len(), 5);
2818         assert_eq!(node_txn[0], node_txn[3]);
2819         assert_eq!(node_txn[1], node_txn[4]);
2820         assert_eq!(node_txn[2], commitment_tx[0]);
2821         check_spends!(node_txn[0], commitment_tx[0]);
2822         check_spends!(node_txn[1], commitment_tx[0]);
2823         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2824         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2825         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2826         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2827         assert_eq!(node_txn[0].lock_time, 0);
2828         assert_eq!(node_txn[1].lock_time, 0);
2829
2830         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2831         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2832         {
2833                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2834                 assert_eq!(added_monitors.len(), 1);
2835                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2836                 added_monitors.clear();
2837         }
2838         let events = nodes[1].node.get_and_clear_pending_msg_events();
2839         {
2840                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2841                 assert_eq!(added_monitors.len(), 2);
2842                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2843                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2844                 added_monitors.clear();
2845         }
2846         assert_eq!(events.len(), 2);
2847         match events[0] {
2848                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2849                 _ => panic!("Unexpected event"),
2850         }
2851         match events[1] {
2852                 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, .. } } => {
2853                         assert!(update_add_htlcs.is_empty());
2854                         assert!(update_fail_htlcs.is_empty());
2855                         assert_eq!(update_fulfill_htlcs.len(), 1);
2856                         assert!(update_fail_malformed_htlcs.is_empty());
2857                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2858                 },
2859                 _ => panic!("Unexpected event"),
2860         };
2861         macro_rules! check_tx_local_broadcast {
2862                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2863                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2864                         assert_eq!(node_txn.len(), 5);
2865                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2866                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2867                         check_spends!(node_txn[0], $commitment_tx);
2868                         check_spends!(node_txn[1], $commitment_tx);
2869                         assert_ne!(node_txn[0].lock_time, 0);
2870                         assert_ne!(node_txn[1].lock_time, 0);
2871                         if $htlc_offered {
2872                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2873                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2874                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2875                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2876                         } else {
2877                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2878                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2879                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2880                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2881                         }
2882                         check_spends!(node_txn[2], $chan_tx);
2883                         check_spends!(node_txn[3], node_txn[2]);
2884                         check_spends!(node_txn[4], node_txn[2]);
2885                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2886                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2887                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2888                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2889                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2890                         assert_ne!(node_txn[3].lock_time, 0);
2891                         assert_ne!(node_txn[4].lock_time, 0);
2892                         node_txn.clear();
2893                 } }
2894         }
2895         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2896         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2897         // timeout-claim of the output that nodes[2] just claimed via success.
2898         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2899
2900         // Broadcast legit commitment tx from A on B's chain
2901         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2902         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2903         check_spends!(commitment_tx[0], chan_1.3);
2904         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2905         check_closed_broadcast!(nodes[1], false);
2906         check_added_monitors!(nodes[1], 1);
2907         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2908         assert_eq!(node_txn.len(), 4);
2909         check_spends!(node_txn[0], commitment_tx[0]);
2910         assert_eq!(node_txn[0].input.len(), 2);
2911         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2912         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2913         assert_eq!(node_txn[0].lock_time, 0);
2914         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2915         check_spends!(node_txn[1], chan_1.3);
2916         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2917         check_spends!(node_txn[2], node_txn[1]);
2918         check_spends!(node_txn[3], node_txn[1]);
2919         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2920         // we already checked the same situation with A.
2921
2922         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2923         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2924         check_closed_broadcast!(nodes[0], false);
2925         check_added_monitors!(nodes[0], 1);
2926         let events = nodes[0].node.get_and_clear_pending_events();
2927         assert_eq!(events.len(), 2);
2928         let mut first_claimed = false;
2929         for event in events {
2930                 match event {
2931                         Event::PaymentSent { payment_preimage } => {
2932                                 if payment_preimage == our_payment_preimage {
2933                                         assert!(!first_claimed);
2934                                         first_claimed = true;
2935                                 } else {
2936                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2937                                 }
2938                         },
2939                         _ => panic!("Unexpected event"),
2940                 }
2941         }
2942         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2943 }
2944
2945 #[test]
2946 fn test_htlc_on_chain_timeout() {
2947         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2948         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2949         // broadcasting the right event to other nodes in payment path.
2950         // A ------------------> B ----------------------> C (timeout)
2951         //    B's commitment tx                 C's commitment tx
2952         //            \                                  \
2953         //         B's HTLC timeout tx               B's timeout tx
2954
2955         let chanmon_cfgs = create_chanmon_cfgs(3);
2956         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2957         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2958         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2959
2960         // Create some intial channels
2961         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2962         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2963
2964         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2965         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2966         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2967
2968         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2969         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2970
2971         // Broadcast legit commitment tx from C on B's chain
2972         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2973         check_spends!(commitment_tx[0], chan_2.3);
2974         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2975         check_added_monitors!(nodes[2], 0);
2976         expect_pending_htlcs_forwardable!(nodes[2]);
2977         check_added_monitors!(nodes[2], 1);
2978
2979         let events = nodes[2].node.get_and_clear_pending_msg_events();
2980         assert_eq!(events.len(), 1);
2981         match events[0] {
2982                 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, .. } } => {
2983                         assert!(update_add_htlcs.is_empty());
2984                         assert!(!update_fail_htlcs.is_empty());
2985                         assert!(update_fulfill_htlcs.is_empty());
2986                         assert!(update_fail_malformed_htlcs.is_empty());
2987                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2988                 },
2989                 _ => panic!("Unexpected event"),
2990         };
2991         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2992         check_closed_broadcast!(nodes[2], false);
2993         check_added_monitors!(nodes[2], 1);
2994         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2995         assert_eq!(node_txn.len(), 1);
2996         check_spends!(node_txn[0], chan_2.3);
2997         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2998
2999         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
3000         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
3001         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3002         let timeout_tx;
3003         {
3004                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3005                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
3006                 assert_eq!(node_txn[1], node_txn[3]);
3007                 assert_eq!(node_txn[2], node_txn[4]);
3008
3009                 check_spends!(node_txn[0], commitment_tx[0]);
3010                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3011
3012                 check_spends!(node_txn[1], chan_2.3);
3013                 check_spends!(node_txn[2], node_txn[1]);
3014                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3015                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3016
3017                 timeout_tx = node_txn[0].clone();
3018                 node_txn.clear();
3019         }
3020
3021         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
3022         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3023         check_added_monitors!(nodes[1], 1);
3024         check_closed_broadcast!(nodes[1], false);
3025
3026         expect_pending_htlcs_forwardable!(nodes[1]);
3027         check_added_monitors!(nodes[1], 1);
3028         let events = nodes[1].node.get_and_clear_pending_msg_events();
3029         assert_eq!(events.len(), 1);
3030         match events[0] {
3031                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
3032                         assert!(update_add_htlcs.is_empty());
3033                         assert!(!update_fail_htlcs.is_empty());
3034                         assert!(update_fulfill_htlcs.is_empty());
3035                         assert!(update_fail_malformed_htlcs.is_empty());
3036                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3037                 },
3038                 _ => panic!("Unexpected event"),
3039         };
3040         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // Well... here we detect our own htlc_timeout_tx so no tx to be generated
3041         assert_eq!(node_txn.len(), 0);
3042
3043         // Broadcast legit commitment tx from B on A's chain
3044         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3045         check_spends!(commitment_tx[0], chan_1.3);
3046
3047         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3048         check_closed_broadcast!(nodes[0], false);
3049         check_added_monitors!(nodes[0], 1);
3050         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3051         assert_eq!(node_txn.len(), 3);
3052         check_spends!(node_txn[0], commitment_tx[0]);
3053         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3054         check_spends!(node_txn[1], chan_1.3);
3055         check_spends!(node_txn[2], node_txn[1]);
3056         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3057         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3058 }
3059
3060 #[test]
3061 fn test_simple_commitment_revoked_fail_backward() {
3062         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3063         // and fail backward accordingly.
3064
3065         let chanmon_cfgs = create_chanmon_cfgs(3);
3066         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3067         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3068         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3069
3070         // Create some initial channels
3071         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3072         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3073
3074         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3075         // Get the will-be-revoked local txn from nodes[2]
3076         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3077         // Revoke the old state
3078         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3079
3080         let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3081
3082         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3083         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3084         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3085         check_added_monitors!(nodes[1], 1);
3086         check_closed_broadcast!(nodes[1], false);
3087
3088         expect_pending_htlcs_forwardable!(nodes[1]);
3089         check_added_monitors!(nodes[1], 1);
3090         let events = nodes[1].node.get_and_clear_pending_msg_events();
3091         assert_eq!(events.len(), 1);
3092         match events[0] {
3093                 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, .. } } => {
3094                         assert!(update_add_htlcs.is_empty());
3095                         assert_eq!(update_fail_htlcs.len(), 1);
3096                         assert!(update_fulfill_htlcs.is_empty());
3097                         assert!(update_fail_malformed_htlcs.is_empty());
3098                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3099
3100                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3101                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3102
3103                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3104                         assert_eq!(events.len(), 1);
3105                         match events[0] {
3106                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3107                                 _ => panic!("Unexpected event"),
3108                         }
3109                         expect_payment_failed!(nodes[0], payment_hash, false);
3110                 },
3111                 _ => panic!("Unexpected event"),
3112         }
3113 }
3114
3115 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3116         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3117         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3118         // commitment transaction anymore.
3119         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3120         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3121         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3122         // technically disallowed and we should probably handle it reasonably.
3123         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3124         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3125         // transactions:
3126         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3127         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3128         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3129         //   and once they revoke the previous commitment transaction (allowing us to send a new
3130         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3131         let chanmon_cfgs = create_chanmon_cfgs(3);
3132         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3133         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3134         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3135
3136         // Create some initial channels
3137         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3138         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3139
3140         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3141         // Get the will-be-revoked local txn from nodes[2]
3142         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3143         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3144         // Revoke the old state
3145         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3146
3147         let value = if use_dust {
3148                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3149                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3150                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
3151         } else { 3000000 };
3152
3153         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3154         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3155         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3156
3157         assert!(nodes[2].node.fail_htlc_backwards(&first_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         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3168         // Drop the last RAA from 3 -> 2
3169
3170         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3171         expect_pending_htlcs_forwardable!(nodes[2]);
3172         check_added_monitors!(nodes[2], 1);
3173         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3174         assert!(updates.update_add_htlcs.is_empty());
3175         assert!(updates.update_fulfill_htlcs.is_empty());
3176         assert!(updates.update_fail_malformed_htlcs.is_empty());
3177         assert_eq!(updates.update_fail_htlcs.len(), 1);
3178         assert!(updates.update_fee.is_none());
3179         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3180         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3181         check_added_monitors!(nodes[1], 1);
3182         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3183         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3184         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3185         check_added_monitors!(nodes[2], 1);
3186
3187         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3188         expect_pending_htlcs_forwardable!(nodes[2]);
3189         check_added_monitors!(nodes[2], 1);
3190         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3191         assert!(updates.update_add_htlcs.is_empty());
3192         assert!(updates.update_fulfill_htlcs.is_empty());
3193         assert!(updates.update_fail_malformed_htlcs.is_empty());
3194         assert_eq!(updates.update_fail_htlcs.len(), 1);
3195         assert!(updates.update_fee.is_none());
3196         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3197         // At this point first_payment_hash has dropped out of the latest two commitment
3198         // transactions that nodes[1] is tracking...
3199         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3200         check_added_monitors!(nodes[1], 1);
3201         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3202         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3203         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3204         check_added_monitors!(nodes[2], 1);
3205
3206         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3207         // on nodes[2]'s RAA.
3208         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3209         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3210         let logger = test_utils::TestLogger::new();
3211         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(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3212         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3213         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3214         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3215         check_added_monitors!(nodes[1], 0);
3216
3217         if deliver_bs_raa {
3218                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3219                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3220                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3221                 check_added_monitors!(nodes[1], 1);
3222                 let events = nodes[1].node.get_and_clear_pending_events();
3223                 assert_eq!(events.len(), 1);
3224                 match events[0] {
3225                         Event::PendingHTLCsForwardable { .. } => { },
3226                         _ => panic!("Unexpected event"),
3227                 };
3228                 // Deliberately don't process the pending fail-back so they all fail back at once after
3229                 // block connection just like the !deliver_bs_raa case
3230         }
3231
3232         let mut failed_htlcs = HashSet::new();
3233         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3234
3235         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3236         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3237         check_added_monitors!(nodes[1], 1);
3238         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3239
3240         let events = nodes[1].node.get_and_clear_pending_events();
3241         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3242         match events[0] {
3243                 Event::PaymentFailed { ref payment_hash, .. } => {
3244                         assert_eq!(*payment_hash, fourth_payment_hash);
3245                 },
3246                 _ => panic!("Unexpected event"),
3247         }
3248         if !deliver_bs_raa {
3249                 match events[1] {
3250                         Event::PendingHTLCsForwardable { .. } => { },
3251                         _ => panic!("Unexpected event"),
3252                 };
3253         }
3254         nodes[1].node.process_pending_htlc_forwards();
3255         check_added_monitors!(nodes[1], 1);
3256
3257         let events = nodes[1].node.get_and_clear_pending_msg_events();
3258         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3259         match events[if deliver_bs_raa { 1 } else { 0 }] {
3260                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3261                 _ => panic!("Unexpected event"),
3262         }
3263         if deliver_bs_raa {
3264                 match events[0] {
3265                         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, .. } } => {
3266                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3267                                 assert_eq!(update_add_htlcs.len(), 1);
3268                                 assert!(update_fulfill_htlcs.is_empty());
3269                                 assert!(update_fail_htlcs.is_empty());
3270                                 assert!(update_fail_malformed_htlcs.is_empty());
3271                         },
3272                         _ => panic!("Unexpected event"),
3273                 }
3274         }
3275         match events[if deliver_bs_raa { 2 } else { 1 }] {
3276                 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, .. } } => {
3277                         assert!(update_add_htlcs.is_empty());
3278                         assert_eq!(update_fail_htlcs.len(), 3);
3279                         assert!(update_fulfill_htlcs.is_empty());
3280                         assert!(update_fail_malformed_htlcs.is_empty());
3281                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3282
3283                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3284                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3285                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3286
3287                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3288
3289                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3290                         // If we delivered B's RAA we got an unknown preimage error, not something
3291                         // that we should update our routing table for.
3292                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3293                         for event in events {
3294                                 match event {
3295                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3296                                         _ => panic!("Unexpected event"),
3297                                 }
3298                         }
3299                         let events = nodes[0].node.get_and_clear_pending_events();
3300                         assert_eq!(events.len(), 3);
3301                         match events[0] {
3302                                 Event::PaymentFailed { ref payment_hash, .. } => {
3303                                         assert!(failed_htlcs.insert(payment_hash.0));
3304                                 },
3305                                 _ => panic!("Unexpected event"),
3306                         }
3307                         match events[1] {
3308                                 Event::PaymentFailed { ref payment_hash, .. } => {
3309                                         assert!(failed_htlcs.insert(payment_hash.0));
3310                                 },
3311                                 _ => panic!("Unexpected event"),
3312                         }
3313                         match events[2] {
3314                                 Event::PaymentFailed { ref payment_hash, .. } => {
3315                                         assert!(failed_htlcs.insert(payment_hash.0));
3316                                 },
3317                                 _ => panic!("Unexpected event"),
3318                         }
3319                 },
3320                 _ => panic!("Unexpected event"),
3321         }
3322
3323         assert!(failed_htlcs.contains(&first_payment_hash.0));
3324         assert!(failed_htlcs.contains(&second_payment_hash.0));
3325         assert!(failed_htlcs.contains(&third_payment_hash.0));
3326 }
3327
3328 #[test]
3329 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3330         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3331         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3332         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3333         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3334 }
3335
3336 #[test]
3337 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3338         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3339         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3340         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3341         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3342 }
3343
3344 #[test]
3345 fn fail_backward_pending_htlc_upon_channel_failure() {
3346         let chanmon_cfgs = create_chanmon_cfgs(2);
3347         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3348         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3349         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3350         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3351         let logger = test_utils::TestLogger::new();
3352
3353         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3354         {
3355                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3356                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3357                 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(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3358                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3359                 check_added_monitors!(nodes[0], 1);
3360
3361                 let payment_event = {
3362                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3363                         assert_eq!(events.len(), 1);
3364                         SendEvent::from_event(events.remove(0))
3365                 };
3366                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3367                 assert_eq!(payment_event.msgs.len(), 1);
3368         }
3369
3370         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3371         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3372         {
3373                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3374                 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(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3375                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3376                 check_added_monitors!(nodes[0], 0);
3377
3378                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3379         }
3380
3381         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3382         {
3383                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3384
3385                 let secp_ctx = Secp256k1::new();
3386                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3387                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3388                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3389                 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(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV, &logger).unwrap();
3390                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3391                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3392                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3393
3394                 // Send a 0-msat update_add_htlc to fail the channel.
3395                 let update_add_htlc = msgs::UpdateAddHTLC {
3396                         channel_id: chan.2,
3397                         htlc_id: 0,
3398                         amount_msat: 0,
3399                         payment_hash,
3400                         cltv_expiry,
3401                         onion_routing_packet,
3402                 };
3403                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3404         }
3405
3406         // Check that Alice fails backward the pending HTLC from the second payment.
3407         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3408         check_closed_broadcast!(nodes[0], true);
3409         check_added_monitors!(nodes[0], 1);
3410 }
3411
3412 #[test]
3413 fn test_htlc_ignore_latest_remote_commitment() {
3414         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3415         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3416         let chanmon_cfgs = create_chanmon_cfgs(2);
3417         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3418         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3419         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3420         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3421
3422         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3423         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3424         check_closed_broadcast!(nodes[0], false);
3425         check_added_monitors!(nodes[0], 1);
3426
3427         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3428         assert_eq!(node_txn.len(), 2);
3429
3430         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3431         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3432         check_closed_broadcast!(nodes[1], false);
3433         check_added_monitors!(nodes[1], 1);
3434
3435         // Duplicate the block_connected call since this may happen due to other listeners
3436         // registering new transactions
3437         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3438 }
3439
3440 #[test]
3441 fn test_force_close_fail_back() {
3442         // Check which HTLCs are failed-backwards on channel force-closure
3443         let chanmon_cfgs = create_chanmon_cfgs(3);
3444         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3445         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3446         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3447         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3448         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3449         let logger = test_utils::TestLogger::new();
3450
3451         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3452
3453         let mut payment_event = {
3454                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3455                 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(), None, &Vec::new(), 1000000, 42, &logger).unwrap();
3456                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3457                 check_added_monitors!(nodes[0], 1);
3458
3459                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3460                 assert_eq!(events.len(), 1);
3461                 SendEvent::from_event(events.remove(0))
3462         };
3463
3464         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3465         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3466
3467         expect_pending_htlcs_forwardable!(nodes[1]);
3468
3469         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3470         assert_eq!(events_2.len(), 1);
3471         payment_event = SendEvent::from_event(events_2.remove(0));
3472         assert_eq!(payment_event.msgs.len(), 1);
3473
3474         check_added_monitors!(nodes[1], 1);
3475         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3476         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3477         check_added_monitors!(nodes[2], 1);
3478         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3479
3480         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3481         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3482         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3483
3484         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3485         check_closed_broadcast!(nodes[2], false);
3486         check_added_monitors!(nodes[2], 1);
3487         let tx = {
3488                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3489                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3490                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3491                 // back to nodes[1] upon timeout otherwise.
3492                 assert_eq!(node_txn.len(), 1);
3493                 node_txn.remove(0)
3494         };
3495
3496         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3497         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3498
3499         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3500         check_closed_broadcast!(nodes[1], false);
3501         check_added_monitors!(nodes[1], 1);
3502
3503         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3504         {
3505                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3506                 monitors.get_mut(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3507                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3508         }
3509         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3510         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3511         assert_eq!(node_txn.len(), 1);
3512         assert_eq!(node_txn[0].input.len(), 1);
3513         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3514         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3515         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3516
3517         check_spends!(node_txn[0], tx);
3518 }
3519
3520 #[test]
3521 fn test_unconf_chan() {
3522         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3523         let chanmon_cfgs = create_chanmon_cfgs(2);
3524         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3525         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3526         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3527         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3528
3529         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3530         assert_eq!(channel_state.by_id.len(), 1);
3531         assert_eq!(channel_state.short_to_id.len(), 1);
3532         mem::drop(channel_state);
3533
3534         let mut headers = Vec::new();
3535         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3536         headers.push(header.clone());
3537         for _i in 2..100 {
3538                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3539                 headers.push(header.clone());
3540         }
3541         let mut height = 99;
3542         while !headers.is_empty() {
3543                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3544                 height -= 1;
3545         }
3546         check_closed_broadcast!(nodes[0], false);
3547         check_added_monitors!(nodes[0], 1);
3548         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3549         assert_eq!(channel_state.by_id.len(), 0);
3550         assert_eq!(channel_state.short_to_id.len(), 0);
3551 }
3552
3553 #[test]
3554 fn test_simple_peer_disconnect() {
3555         // Test that we can reconnect when there are no lost messages
3556         let chanmon_cfgs = create_chanmon_cfgs(3);
3557         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3558         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3559         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3560         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3561         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3562
3563         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3564         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3565         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3566
3567         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3568         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3569         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3570         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3571
3572         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3573         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3574         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3575
3576         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3577         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3578         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3579         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3580
3581         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3582         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3583
3584         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3585         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3586
3587         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3588         {
3589                 let events = nodes[0].node.get_and_clear_pending_events();
3590                 assert_eq!(events.len(), 2);
3591                 match events[0] {
3592                         Event::PaymentSent { payment_preimage } => {
3593                                 assert_eq!(payment_preimage, payment_preimage_3);
3594                         },
3595                         _ => panic!("Unexpected event"),
3596                 }
3597                 match events[1] {
3598                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3599                                 assert_eq!(payment_hash, payment_hash_5);
3600                                 assert!(rejected_by_dest);
3601                         },
3602                         _ => panic!("Unexpected event"),
3603                 }
3604         }
3605
3606         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3607         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3608 }
3609
3610 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3611         // Test that we can reconnect when in-flight HTLC updates get dropped
3612         let chanmon_cfgs = create_chanmon_cfgs(2);
3613         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3614         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3615         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3616         if messages_delivered == 0 {
3617                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3618                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3619         } else {
3620                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3621         }
3622
3623         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3624
3625         let logger = test_utils::TestLogger::new();
3626         let payment_event = {
3627                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3628                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3629                         &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3630                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3631                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3632                 check_added_monitors!(nodes[0], 1);
3633
3634                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3635                 assert_eq!(events.len(), 1);
3636                 SendEvent::from_event(events.remove(0))
3637         };
3638         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3639
3640         if messages_delivered < 2 {
3641                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3642         } else {
3643                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3644                 if messages_delivered >= 3 {
3645                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3646                         check_added_monitors!(nodes[1], 1);
3647                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3648
3649                         if messages_delivered >= 4 {
3650                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3651                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3652                                 check_added_monitors!(nodes[0], 1);
3653
3654                                 if messages_delivered >= 5 {
3655                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3656                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3657                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3658                                         check_added_monitors!(nodes[0], 1);
3659
3660                                         if messages_delivered >= 6 {
3661                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3662                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3663                                                 check_added_monitors!(nodes[1], 1);
3664                                         }
3665                                 }
3666                         }
3667                 }
3668         }
3669
3670         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3671         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3672         if messages_delivered < 3 {
3673                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3674                 // received on either side, both sides will need to resend them.
3675                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3676         } else if messages_delivered == 3 {
3677                 // nodes[0] still wants its RAA + commitment_signed
3678                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3679         } else if messages_delivered == 4 {
3680                 // nodes[0] still wants its commitment_signed
3681                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3682         } else if messages_delivered == 5 {
3683                 // nodes[1] still wants its final RAA
3684                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3685         } else if messages_delivered == 6 {
3686                 // Everything was delivered...
3687                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3688         }
3689
3690         let events_1 = nodes[1].node.get_and_clear_pending_events();
3691         assert_eq!(events_1.len(), 1);
3692         match events_1[0] {
3693                 Event::PendingHTLCsForwardable { .. } => { },
3694                 _ => panic!("Unexpected event"),
3695         };
3696
3697         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3698         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3699         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3700
3701         nodes[1].node.process_pending_htlc_forwards();
3702
3703         let events_2 = nodes[1].node.get_and_clear_pending_events();
3704         assert_eq!(events_2.len(), 1);
3705         match events_2[0] {
3706                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3707                         assert_eq!(payment_hash_1, *payment_hash);
3708                         assert_eq!(*payment_secret, None);
3709                         assert_eq!(amt, 1000000);
3710                 },
3711                 _ => panic!("Unexpected event"),
3712         }
3713
3714         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3715         check_added_monitors!(nodes[1], 1);
3716
3717         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3718         assert_eq!(events_3.len(), 1);
3719         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3720                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3721                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3722                         assert!(updates.update_add_htlcs.is_empty());
3723                         assert!(updates.update_fail_htlcs.is_empty());
3724                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3725                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3726                         assert!(updates.update_fee.is_none());
3727                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3728                 },
3729                 _ => panic!("Unexpected event"),
3730         };
3731
3732         if messages_delivered >= 1 {
3733                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3734
3735                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3736                 assert_eq!(events_4.len(), 1);
3737                 match events_4[0] {
3738                         Event::PaymentSent { ref payment_preimage } => {
3739                                 assert_eq!(payment_preimage_1, *payment_preimage);
3740                         },
3741                         _ => panic!("Unexpected event"),
3742                 }
3743
3744                 if messages_delivered >= 2 {
3745                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3746                         check_added_monitors!(nodes[0], 1);
3747                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3748
3749                         if messages_delivered >= 3 {
3750                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3751                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3752                                 check_added_monitors!(nodes[1], 1);
3753
3754                                 if messages_delivered >= 4 {
3755                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3756                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3757                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3758                                         check_added_monitors!(nodes[1], 1);
3759
3760                                         if messages_delivered >= 5 {
3761                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3762                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3763                                                 check_added_monitors!(nodes[0], 1);
3764                                         }
3765                                 }
3766                         }
3767                 }
3768         }
3769
3770         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3771         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3772         if messages_delivered < 2 {
3773                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3774                 //TODO: Deduplicate PaymentSent events, then enable this if:
3775                 //if messages_delivered < 1 {
3776                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3777                         assert_eq!(events_4.len(), 1);
3778                         match events_4[0] {
3779                                 Event::PaymentSent { ref payment_preimage } => {
3780                                         assert_eq!(payment_preimage_1, *payment_preimage);
3781                                 },
3782                                 _ => panic!("Unexpected event"),
3783                         }
3784                 //}
3785         } else if messages_delivered == 2 {
3786                 // nodes[0] still wants its RAA + commitment_signed
3787                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3788         } else if messages_delivered == 3 {
3789                 // nodes[0] still wants its commitment_signed
3790                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3791         } else if messages_delivered == 4 {
3792                 // nodes[1] still wants its final RAA
3793                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3794         } else if messages_delivered == 5 {
3795                 // Everything was delivered...
3796                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3797         }
3798
3799         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3800         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3801         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3802
3803         // Channel should still work fine...
3804         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3805         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3806                 &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3807                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3808         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3809         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3810 }
3811
3812 #[test]
3813 fn test_drop_messages_peer_disconnect_a() {
3814         do_test_drop_messages_peer_disconnect(0);
3815         do_test_drop_messages_peer_disconnect(1);
3816         do_test_drop_messages_peer_disconnect(2);
3817         do_test_drop_messages_peer_disconnect(3);
3818 }
3819
3820 #[test]
3821 fn test_drop_messages_peer_disconnect_b() {
3822         do_test_drop_messages_peer_disconnect(4);
3823         do_test_drop_messages_peer_disconnect(5);
3824         do_test_drop_messages_peer_disconnect(6);
3825 }
3826
3827 #[test]
3828 fn test_funding_peer_disconnect() {
3829         // Test that we can lock in our funding tx while disconnected
3830         let chanmon_cfgs = create_chanmon_cfgs(2);
3831         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3832         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3833         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3834         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3835
3836         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3837         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3838
3839         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3840         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3841         assert_eq!(events_1.len(), 1);
3842         match events_1[0] {
3843                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3844                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3845                 },
3846                 _ => panic!("Unexpected event"),
3847         }
3848
3849         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3850
3851         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3852         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3853
3854         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3855         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3856         assert_eq!(events_2.len(), 2);
3857         let funding_locked = match events_2[0] {
3858                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3859                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3860                         msg.clone()
3861                 },
3862                 _ => panic!("Unexpected event"),
3863         };
3864         let bs_announcement_sigs = match events_2[1] {
3865                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3866                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3867                         msg.clone()
3868                 },
3869                 _ => panic!("Unexpected event"),
3870         };
3871
3872         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3873
3874         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3875         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3876         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3877         assert_eq!(events_3.len(), 2);
3878         let as_announcement_sigs = match events_3[0] {
3879                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3880                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3881                         msg.clone()
3882                 },
3883                 _ => panic!("Unexpected event"),
3884         };
3885         let (as_announcement, as_update) = match events_3[1] {
3886                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3887                         (msg.clone(), update_msg.clone())
3888                 },
3889                 _ => panic!("Unexpected event"),
3890         };
3891
3892         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3893         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3894         assert_eq!(events_4.len(), 1);
3895         let (_, bs_update) = match events_4[0] {
3896                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3897                         (msg.clone(), update_msg.clone())
3898                 },
3899                 _ => panic!("Unexpected event"),
3900         };
3901
3902         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3903         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3904         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3905
3906         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3907         let logger = test_utils::TestLogger::new();
3908         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(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3909         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3910         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3911 }
3912
3913 #[test]
3914 fn test_drop_messages_peer_disconnect_dual_htlc() {
3915         // Test that we can handle reconnecting when both sides of a channel have pending
3916         // commitment_updates when we disconnect.
3917         let chanmon_cfgs = create_chanmon_cfgs(2);
3918         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3919         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3920         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3921         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3922         let logger = test_utils::TestLogger::new();
3923
3924         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3925
3926         // Now try to send a second payment which will fail to send
3927         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3928         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3929         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(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3930         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3931         check_added_monitors!(nodes[0], 1);
3932
3933         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3934         assert_eq!(events_1.len(), 1);
3935         match events_1[0] {
3936                 MessageSendEvent::UpdateHTLCs { .. } => {},
3937                 _ => panic!("Unexpected event"),
3938         }
3939
3940         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3941         check_added_monitors!(nodes[1], 1);
3942
3943         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3944         assert_eq!(events_2.len(), 1);
3945         match events_2[0] {
3946                 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 } } => {
3947                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3948                         assert!(update_add_htlcs.is_empty());
3949                         assert_eq!(update_fulfill_htlcs.len(), 1);
3950                         assert!(update_fail_htlcs.is_empty());
3951                         assert!(update_fail_malformed_htlcs.is_empty());
3952                         assert!(update_fee.is_none());
3953
3954                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3955                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3956                         assert_eq!(events_3.len(), 1);
3957                         match events_3[0] {
3958                                 Event::PaymentSent { ref payment_preimage } => {
3959                                         assert_eq!(*payment_preimage, payment_preimage_1);
3960                                 },
3961                                 _ => panic!("Unexpected event"),
3962                         }
3963
3964                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3965                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3966                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3967                         check_added_monitors!(nodes[0], 1);
3968                 },
3969                 _ => panic!("Unexpected event"),
3970         }
3971
3972         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3973         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3974
3975         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3976         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3977         assert_eq!(reestablish_1.len(), 1);
3978         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3979         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3980         assert_eq!(reestablish_2.len(), 1);
3981
3982         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3983         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3984         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3985         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3986
3987         assert!(as_resp.0.is_none());
3988         assert!(bs_resp.0.is_none());
3989
3990         assert!(bs_resp.1.is_none());
3991         assert!(bs_resp.2.is_none());
3992
3993         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3994
3995         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3996         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3997         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3998         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3999         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4000         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4001         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4002         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4003         // No commitment_signed so get_event_msg's assert(len == 1) passes
4004         check_added_monitors!(nodes[1], 1);
4005
4006         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4007         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4008         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4009         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4010         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4011         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4012         assert!(bs_second_commitment_signed.update_fee.is_none());
4013         check_added_monitors!(nodes[1], 1);
4014
4015         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4016         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4017         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4018         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4019         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4020         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4021         assert!(as_commitment_signed.update_fee.is_none());
4022         check_added_monitors!(nodes[0], 1);
4023
4024         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4025         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4026         // No commitment_signed so get_event_msg's assert(len == 1) passes
4027         check_added_monitors!(nodes[0], 1);
4028
4029         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4030         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4031         // No commitment_signed so get_event_msg's assert(len == 1) passes
4032         check_added_monitors!(nodes[1], 1);
4033
4034         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4035         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4036         check_added_monitors!(nodes[1], 1);
4037
4038         expect_pending_htlcs_forwardable!(nodes[1]);
4039
4040         let events_5 = nodes[1].node.get_and_clear_pending_events();
4041         assert_eq!(events_5.len(), 1);
4042         match events_5[0] {
4043                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
4044                         assert_eq!(payment_hash_2, *payment_hash);
4045                         assert_eq!(*payment_secret, None);
4046                 },
4047                 _ => panic!("Unexpected event"),
4048         }
4049
4050         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4051         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4052         check_added_monitors!(nodes[0], 1);
4053
4054         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
4055 }
4056
4057 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4058         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4059         // to avoid our counterparty failing the channel.
4060         let chanmon_cfgs = create_chanmon_cfgs(2);
4061         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4062         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4063         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4064
4065         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4066         let logger = test_utils::TestLogger::new();
4067
4068         let our_payment_hash = if send_partial_mpp {
4069                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4070                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4071                 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4072                 let payment_secret = PaymentSecret([0xdb; 32]);
4073                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4074                 // indicates there are more HTLCs coming.
4075                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, CHAN_CONFIRM_DEPTH).unwrap();
4076                 check_added_monitors!(nodes[0], 1);
4077                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4078                 assert_eq!(events.len(), 1);
4079                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4080                 // hop should *not* yet generate any PaymentReceived event(s).
4081                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4082                 our_payment_hash
4083         } else {
4084                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4085         };
4086
4087         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4088         nodes[0].block_notifier.block_connected_checked(&header, 101, &[], &[]);
4089         nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
4090         for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4091                 header.prev_blockhash = header.bitcoin_hash();
4092                 nodes[0].block_notifier.block_connected_checked(&header, i, &[], &[]);
4093                 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
4094         }
4095
4096         expect_pending_htlcs_forwardable!(nodes[1]);
4097
4098         check_added_monitors!(nodes[1], 1);
4099         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4100         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4101         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4102         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4103         assert!(htlc_timeout_updates.update_fee.is_none());
4104
4105         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4106         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4107         // 100_000 msat as u64, followed by a height of 123 as u32
4108         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4109         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(123));
4110         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4111 }
4112
4113 #[test]
4114 fn test_htlc_timeout() {
4115         do_test_htlc_timeout(true);
4116         do_test_htlc_timeout(false);
4117 }
4118
4119 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4120         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4121         let chanmon_cfgs = create_chanmon_cfgs(3);
4122         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4123         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4124         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4125         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4126         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4127         let logger = test_utils::TestLogger::new();
4128
4129         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4130         let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4131         {
4132                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4133                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4134                 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4135         }
4136         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4137         check_added_monitors!(nodes[1], 1);
4138
4139         // Now attempt to route a second payment, which should be placed in the holding cell
4140         let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4141         if forwarded_htlc {
4142                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4143                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4144                 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4145                 check_added_monitors!(nodes[0], 1);
4146                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4147                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4148                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4149                 expect_pending_htlcs_forwardable!(nodes[1]);
4150                 check_added_monitors!(nodes[1], 0);
4151         } else {
4152                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4153                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
4154                 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4155                 check_added_monitors!(nodes[1], 0);
4156         }
4157
4158         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4159         nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
4160         for i in 102..TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4161                 header.prev_blockhash = header.bitcoin_hash();
4162                 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
4163         }
4164
4165         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4166         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4167
4168         header.prev_blockhash = header.bitcoin_hash();
4169         nodes[1].block_notifier.block_connected_checked(&header, TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS, &[], &[]);
4170
4171         if forwarded_htlc {
4172                 expect_pending_htlcs_forwardable!(nodes[1]);
4173                 check_added_monitors!(nodes[1], 1);
4174                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4175                 assert_eq!(fail_commit.len(), 1);
4176                 match fail_commit[0] {
4177                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4178                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4179                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4180                         },
4181                         _ => unreachable!(),
4182                 }
4183                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4184                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4185                         match update {
4186                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4187                                 _ => panic!("Unexpected event"),
4188                         }
4189                 } else {
4190                         panic!("Unexpected event");
4191                 }
4192         } else {
4193                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4194         }
4195 }
4196
4197 #[test]
4198 fn test_holding_cell_htlc_add_timeouts() {
4199         do_test_holding_cell_htlc_add_timeouts(false);
4200         do_test_holding_cell_htlc_add_timeouts(true);
4201 }
4202
4203 #[test]
4204 fn test_invalid_channel_announcement() {
4205         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4206         let secp_ctx = Secp256k1::new();
4207         let chanmon_cfgs = create_chanmon_cfgs(2);
4208         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4209         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4210         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4211
4212         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4213
4214         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4215         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4216         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4217         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4218
4219         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 } );
4220
4221         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4222         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4223
4224         let as_network_key = nodes[0].node.get_our_node_id();
4225         let bs_network_key = nodes[1].node.get_our_node_id();
4226
4227         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4228
4229         let mut chan_announcement;
4230
4231         macro_rules! dummy_unsigned_msg {
4232                 () => {
4233                         msgs::UnsignedChannelAnnouncement {
4234                                 features: ChannelFeatures::known(),
4235                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
4236                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4237                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4238                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4239                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4240                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4241                                 excess_data: Vec::new(),
4242                         };
4243                 }
4244         }
4245
4246         macro_rules! sign_msg {
4247                 ($unsigned_msg: expr) => {
4248                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4249                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
4250                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
4251                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4252                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4253                         chan_announcement = msgs::ChannelAnnouncement {
4254                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4255                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4256                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4257                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4258                                 contents: $unsigned_msg
4259                         }
4260                 }
4261         }
4262
4263         let unsigned_msg = dummy_unsigned_msg!();
4264         sign_msg!(unsigned_msg);
4265         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4266         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 } );
4267
4268         // Configured with Network::Testnet
4269         let mut unsigned_msg = dummy_unsigned_msg!();
4270         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
4271         sign_msg!(unsigned_msg);
4272         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4273
4274         let mut unsigned_msg = dummy_unsigned_msg!();
4275         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4276         sign_msg!(unsigned_msg);
4277         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4278 }
4279
4280 #[test]
4281 fn test_no_txn_manager_serialize_deserialize() {
4282         let chanmon_cfgs = create_chanmon_cfgs(2);
4283         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4284         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4285         let logger: test_utils::TestLogger;
4286         let fee_estimator: test_utils::TestFeeEstimator;
4287         let new_chan_monitor: test_utils::TestChannelMonitor;
4288         let keys_manager: test_utils::TestKeysInterface;
4289         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4290         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4291
4292         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4293
4294         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4295
4296         let nodes_0_serialized = nodes[0].node.encode();
4297         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4298         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4299
4300         logger = test_utils::TestLogger::new();
4301         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4302         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4303         nodes[0].chan_monitor = &new_chan_monitor;
4304         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4305         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4306         assert!(chan_0_monitor_read.is_empty());
4307
4308         let mut nodes_0_read = &nodes_0_serialized[..];
4309         let config = UserConfig::default();
4310         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4311         let (_, nodes_0_deserialized_tmp) = {
4312                 let mut channel_monitors = HashMap::new();
4313                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4314                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4315                         default_config: config,
4316                         keys_manager: &keys_manager,
4317                         fee_estimator: &fee_estimator,
4318                         monitor: nodes[0].chan_monitor,
4319                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4320                         logger: &logger,
4321                         channel_monitors,
4322                 }).unwrap()
4323         };
4324         nodes_0_deserialized = nodes_0_deserialized_tmp;
4325         assert!(nodes_0_read.is_empty());
4326
4327         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4328         nodes[0].node = &nodes_0_deserialized;
4329         nodes[0].block_notifier.register_listener(nodes[0].node);
4330         assert_eq!(nodes[0].node.list_channels().len(), 1);
4331         check_added_monitors!(nodes[0], 1);
4332
4333         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4334         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4335         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4336         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4337
4338         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4339         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4340         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4341         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4342
4343         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4344         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4345         for node in nodes.iter() {
4346                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4347                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4348                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4349         }
4350
4351         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4352 }
4353
4354 #[test]
4355 fn test_manager_serialize_deserialize_events() {
4356         // This test makes sure the events field in ChannelManager survives de/serialization
4357         let chanmon_cfgs = create_chanmon_cfgs(2);
4358         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4359         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4360         let fee_estimator: test_utils::TestFeeEstimator;
4361         let logger: test_utils::TestLogger;
4362         let new_chan_monitor: test_utils::TestChannelMonitor;
4363         let keys_manager: test_utils::TestKeysInterface;
4364         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4365         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4366
4367         // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4368         let channel_value = 100000;
4369         let push_msat = 10001;
4370         let a_flags = InitFeatures::known();
4371         let b_flags = InitFeatures::known();
4372         let node_a = nodes.pop().unwrap();
4373         let node_b = nodes.pop().unwrap();
4374         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4375         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()));
4376         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()));
4377
4378         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4379
4380         node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4381         check_added_monitors!(node_a, 0);
4382
4383         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()));
4384         {
4385                 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
4386                 assert_eq!(added_monitors.len(), 1);
4387                 assert_eq!(added_monitors[0].0, funding_output);
4388                 added_monitors.clear();
4389         }
4390
4391         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()));
4392         {
4393                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
4394                 assert_eq!(added_monitors.len(), 1);
4395                 assert_eq!(added_monitors[0].0, funding_output);
4396                 added_monitors.clear();
4397         }
4398         // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4399
4400         nodes.push(node_a);
4401         nodes.push(node_b);
4402
4403         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4404         let nodes_0_serialized = nodes[0].node.encode();
4405         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4406         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4407
4408         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4409         logger = test_utils::TestLogger::new();
4410         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4411         nodes[0].chan_monitor = &new_chan_monitor;
4412         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4413         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4414         assert!(chan_0_monitor_read.is_empty());
4415
4416         let mut nodes_0_read = &nodes_0_serialized[..];
4417         let config = UserConfig::default();
4418         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4419         let (_, nodes_0_deserialized_tmp) = {
4420                 let mut channel_monitors = HashMap::new();
4421                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4422                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4423                         default_config: config,
4424                         keys_manager: &keys_manager,
4425                         fee_estimator: &fee_estimator,
4426                         monitor: nodes[0].chan_monitor,
4427                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4428                         logger: &logger,
4429                         channel_monitors,
4430                 }).unwrap()
4431         };
4432         nodes_0_deserialized = nodes_0_deserialized_tmp;
4433         assert!(nodes_0_read.is_empty());
4434
4435         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4436
4437         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4438         nodes[0].node = &nodes_0_deserialized;
4439
4440         // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4441         let events_4 = nodes[0].node.get_and_clear_pending_events();
4442         assert_eq!(events_4.len(), 1);
4443         match events_4[0] {
4444                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4445                         assert_eq!(user_channel_id, 42);
4446                         assert_eq!(*funding_txo, funding_output);
4447                 },
4448                 _ => panic!("Unexpected event"),
4449         };
4450
4451         // Make sure the channel is functioning as though the de/serialization never happened
4452         nodes[0].block_notifier.register_listener(nodes[0].node);
4453         assert_eq!(nodes[0].node.list_channels().len(), 1);
4454         check_added_monitors!(nodes[0], 1);
4455
4456         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4457         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4458         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4459         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4460
4461         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4462         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4463         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4464         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4465
4466         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4467         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4468         for node in nodes.iter() {
4469                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4470                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4471                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4472         }
4473
4474         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4475 }
4476
4477 #[test]
4478 fn test_simple_manager_serialize_deserialize() {
4479         let chanmon_cfgs = create_chanmon_cfgs(2);
4480         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4481         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4482         let logger: test_utils::TestLogger;
4483         let fee_estimator: test_utils::TestFeeEstimator;
4484         let new_chan_monitor: test_utils::TestChannelMonitor;
4485         let keys_manager: test_utils::TestKeysInterface;
4486         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4487         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4488         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4489
4490         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4491         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4492
4493         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4494
4495         let nodes_0_serialized = nodes[0].node.encode();
4496         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4497         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4498
4499         logger = test_utils::TestLogger::new();
4500         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4501         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4502         nodes[0].chan_monitor = &new_chan_monitor;
4503         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4504         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4505         assert!(chan_0_monitor_read.is_empty());
4506
4507         let mut nodes_0_read = &nodes_0_serialized[..];
4508         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4509         let (_, nodes_0_deserialized_tmp) = {
4510                 let mut channel_monitors = HashMap::new();
4511                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4512                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4513                         default_config: UserConfig::default(),
4514                         keys_manager: &keys_manager,
4515                         fee_estimator: &fee_estimator,
4516                         monitor: nodes[0].chan_monitor,
4517                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4518                         logger: &logger,
4519                         channel_monitors,
4520                 }).unwrap()
4521         };
4522         nodes_0_deserialized = nodes_0_deserialized_tmp;
4523         assert!(nodes_0_read.is_empty());
4524
4525         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4526         nodes[0].node = &nodes_0_deserialized;
4527         check_added_monitors!(nodes[0], 1);
4528
4529         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4530
4531         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4532         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4533 }
4534
4535 #[test]
4536 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4537         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4538         let chanmon_cfgs = create_chanmon_cfgs(4);
4539         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4540         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4541         let logger: test_utils::TestLogger;
4542         let fee_estimator: test_utils::TestFeeEstimator;
4543         let new_chan_monitor: test_utils::TestChannelMonitor;
4544         let keys_manager: test_utils::TestKeysInterface;
4545         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4546         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4547         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4548         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4549         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4550
4551         let mut node_0_stale_monitors_serialized = Vec::new();
4552         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4553                 let mut writer = test_utils::TestVecWriter(Vec::new());
4554                 monitor.1.write_for_disk(&mut writer).unwrap();
4555                 node_0_stale_monitors_serialized.push(writer.0);
4556         }
4557
4558         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4559
4560         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4561         let nodes_0_serialized = nodes[0].node.encode();
4562
4563         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4564         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4565         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4566         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4567
4568         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4569         // nodes[3])
4570         let mut node_0_monitors_serialized = Vec::new();
4571         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4572                 let mut writer = test_utils::TestVecWriter(Vec::new());
4573                 monitor.1.write_for_disk(&mut writer).unwrap();
4574                 node_0_monitors_serialized.push(writer.0);
4575         }
4576
4577         logger = test_utils::TestLogger::new();
4578         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4579         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4580         nodes[0].chan_monitor = &new_chan_monitor;
4581
4582         let mut node_0_stale_monitors = Vec::new();
4583         for serialized in node_0_stale_monitors_serialized.iter() {
4584                 let mut read = &serialized[..];
4585                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4586                 assert!(read.is_empty());
4587                 node_0_stale_monitors.push(monitor);
4588         }
4589
4590         let mut node_0_monitors = Vec::new();
4591         for serialized in node_0_monitors_serialized.iter() {
4592                 let mut read = &serialized[..];
4593                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4594                 assert!(read.is_empty());
4595                 node_0_monitors.push(monitor);
4596         }
4597
4598         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4599
4600         let mut nodes_0_read = &nodes_0_serialized[..];
4601         if let Err(msgs::DecodeError::InvalidValue) =
4602                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4603                 default_config: UserConfig::default(),
4604                 keys_manager: &keys_manager,
4605                 fee_estimator: &fee_estimator,
4606                 monitor: nodes[0].chan_monitor,
4607                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4608                 logger: &logger,
4609                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4610         }) { } else {
4611                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4612         };
4613
4614         let mut nodes_0_read = &nodes_0_serialized[..];
4615         let (_, nodes_0_deserialized_tmp) =
4616                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4617                 default_config: UserConfig::default(),
4618                 keys_manager: &keys_manager,
4619                 fee_estimator: &fee_estimator,
4620                 monitor: nodes[0].chan_monitor,
4621                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4622                 logger: &logger,
4623                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4624         }).unwrap();
4625         nodes_0_deserialized = nodes_0_deserialized_tmp;
4626         assert!(nodes_0_read.is_empty());
4627
4628         { // Channel close should result in a commitment tx and an HTLC tx
4629                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4630                 assert_eq!(txn.len(), 2);
4631                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4632                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4633         }
4634
4635         for monitor in node_0_monitors.drain(..) {
4636                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().0, monitor).is_ok());
4637                 check_added_monitors!(nodes[0], 1);
4638         }
4639         nodes[0].node = &nodes_0_deserialized;
4640
4641         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4642         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4643         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4644         //... and we can even still claim the payment!
4645         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4646
4647         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4648         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4649         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4650         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4651         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4652         assert_eq!(msg_events.len(), 1);
4653         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4654                 match action {
4655                         &ErrorAction::SendErrorMessage { ref msg } => {
4656                                 assert_eq!(msg.channel_id, channel_id);
4657                         },
4658                         _ => panic!("Unexpected event!"),
4659                 }
4660         }
4661 }
4662
4663 macro_rules! check_spendable_outputs {
4664         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4665                 {
4666                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
4667                         let mut txn = Vec::new();
4668                         for event in events {
4669                                 match event {
4670                                         Event::SpendableOutputs { ref outputs } => {
4671                                                 for outp in outputs {
4672                                                         match *outp {
4673                                                                 SpendableOutputDescriptor::StaticOutputRemotePayment { ref outpoint, ref output, ref key_derivation_params } => {
4674                                                                         let input = TxIn {
4675                                                                                 previous_output: outpoint.into_bitcoin_outpoint(),
4676                                                                                 script_sig: Script::new(),
4677                                                                                 sequence: 0,
4678                                                                                 witness: Vec::new(),
4679                                                                         };
4680                                                                         let outp = TxOut {
4681                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4682                                                                                 value: output.value,
4683                                                                         };
4684                                                                         let mut spend_tx = Transaction {
4685                                                                                 version: 2,
4686                                                                                 lock_time: 0,
4687                                                                                 input: vec![input],
4688                                                                                 output: vec![outp],
4689                                                                         };
4690                                                                         let secp_ctx = Secp256k1::new();
4691                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4692                                                                         let remotepubkey = keys.pubkeys().payment_point;
4693                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4694                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4695                                                                         let remotesig = secp_ctx.sign(&sighash, &keys.inner.payment_key);
4696                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4697                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4698                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4699                                                                         txn.push(spend_tx);
4700                                                                 },
4701                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref per_commitment_point, ref to_self_delay, ref output, ref key_derivation_params, ref remote_revocation_pubkey } => {
4702                                                                         let input = TxIn {
4703                                                                                 previous_output: outpoint.into_bitcoin_outpoint(),
4704                                                                                 script_sig: Script::new(),
4705                                                                                 sequence: *to_self_delay as u32,
4706                                                                                 witness: Vec::new(),
4707                                                                         };
4708                                                                         let outp = TxOut {
4709                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4710                                                                                 value: output.value,
4711                                                                         };
4712                                                                         let mut spend_tx = Transaction {
4713                                                                                 version: 2,
4714                                                                                 lock_time: 0,
4715                                                                                 input: vec![input],
4716                                                                                 output: vec![outp],
4717                                                                         };
4718                                                                         let secp_ctx = Secp256k1::new();
4719                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4720                                                                         if let Ok(delayed_payment_key) = chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &keys.inner.delayed_payment_base_key) {
4721
4722                                                                                 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
4723                                                                                 let witness_script = chan_utils::get_revokeable_redeemscript(remote_revocation_pubkey, *to_self_delay, &delayed_payment_pubkey);
4724                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4725                                                                                 let local_delayedsig = secp_ctx.sign(&sighash, &delayed_payment_key);
4726                                                                                 spend_tx.input[0].witness.push(local_delayedsig.serialize_der().to_vec());
4727                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4728                                                                                 spend_tx.input[0].witness.push(vec!()); //MINIMALIF
4729                                                                                 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4730                                                                         } else { panic!() }
4731                                                                         txn.push(spend_tx);
4732                                                                 },
4733                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4734                                                                         let secp_ctx = Secp256k1::new();
4735                                                                         let input = TxIn {
4736                                                                                 previous_output: outpoint.into_bitcoin_outpoint(),
4737                                                                                 script_sig: Script::new(),
4738                                                                                 sequence: 0,
4739                                                                                 witness: Vec::new(),
4740                                                                         };
4741                                                                         let outp = TxOut {
4742                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4743                                                                                 value: output.value,
4744                                                                         };
4745                                                                         let mut spend_tx = Transaction {
4746                                                                                 version: 2,
4747                                                                                 lock_time: 0,
4748                                                                                 input: vec![input],
4749                                                                                 output: vec![outp.clone()],
4750                                                                         };
4751                                                                         let secret = {
4752                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4753                                                                                         Ok(master_key) => {
4754                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4755                                                                                                         Ok(key) => key,
4756                                                                                                         Err(_) => panic!("Your RNG is busted"),
4757                                                                                                 }
4758                                                                                         }
4759                                                                                         Err(_) => panic!("Your rng is busted"),
4760                                                                                 }
4761                                                                         };
4762                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4763                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4764                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4765                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4766                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4767                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4768                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4769                                                                         txn.push(spend_tx);
4770                                                                 },
4771                                                         }
4772                                                 }
4773                                         },
4774                                         _ => panic!("Unexpected event"),
4775                                 };
4776                         }
4777                         txn
4778                 }
4779         }
4780 }
4781
4782 #[test]
4783 fn test_claim_sizeable_push_msat() {
4784         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4785         let chanmon_cfgs = create_chanmon_cfgs(2);
4786         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4787         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4788         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4789
4790         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4791         nodes[1].node.force_close_channel(&chan.2);
4792         check_closed_broadcast!(nodes[1], false);
4793         check_added_monitors!(nodes[1], 1);
4794         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4795         assert_eq!(node_txn.len(), 1);
4796         check_spends!(node_txn[0], chan.3);
4797         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
4798
4799         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4800         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4801         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4802
4803         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4804         assert_eq!(spend_txn.len(), 1);
4805         check_spends!(spend_txn[0], node_txn[0]);
4806 }
4807
4808 #[test]
4809 fn test_claim_on_remote_sizeable_push_msat() {
4810         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4811         // to_remote output is encumbered by a P2WPKH
4812         let chanmon_cfgs = create_chanmon_cfgs(2);
4813         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4814         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4815         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4816
4817         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4818         nodes[0].node.force_close_channel(&chan.2);
4819         check_closed_broadcast!(nodes[0], false);
4820         check_added_monitors!(nodes[0], 1);
4821
4822         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4823         assert_eq!(node_txn.len(), 1);
4824         check_spends!(node_txn[0], chan.3);
4825         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
4826
4827         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4828         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4829         check_closed_broadcast!(nodes[1], false);
4830         check_added_monitors!(nodes[1], 1);
4831         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4832
4833         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4834         assert_eq!(spend_txn.len(), 2);
4835         assert_eq!(spend_txn[0], spend_txn[1]);
4836         check_spends!(spend_txn[0], node_txn[0]);
4837 }
4838
4839 #[test]
4840 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4841         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4842         // to_remote output is encumbered by a P2WPKH
4843
4844         let chanmon_cfgs = create_chanmon_cfgs(2);
4845         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4846         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4847         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4848
4849         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4850         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4851         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4852         assert_eq!(revoked_local_txn[0].input.len(), 1);
4853         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4854
4855         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4856         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4857         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4858         check_closed_broadcast!(nodes[1], false);
4859         check_added_monitors!(nodes[1], 1);
4860
4861         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4862         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4863         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4864         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4865
4866         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4867         assert_eq!(spend_txn.len(), 3);
4868         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4869         check_spends!(spend_txn[0], revoked_local_txn[0]);
4870         check_spends!(spend_txn[2], node_txn[0]);
4871 }
4872
4873 #[test]
4874 fn test_static_spendable_outputs_preimage_tx() {
4875         let chanmon_cfgs = create_chanmon_cfgs(2);
4876         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4877         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4878         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4879
4880         // Create some initial channels
4881         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4882
4883         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4884
4885         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4886         assert_eq!(commitment_tx[0].input.len(), 1);
4887         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4888
4889         // Settle A's commitment tx on B's chain
4890         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4891         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4892         check_added_monitors!(nodes[1], 1);
4893         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4894         check_added_monitors!(nodes[1], 1);
4895         let events = nodes[1].node.get_and_clear_pending_msg_events();
4896         match events[0] {
4897                 MessageSendEvent::UpdateHTLCs { .. } => {},
4898                 _ => panic!("Unexpected event"),
4899         }
4900         match events[1] {
4901                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4902                 _ => panic!("Unexepected event"),
4903         }
4904
4905         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4906         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4907         assert_eq!(node_txn.len(), 3);
4908         check_spends!(node_txn[0], commitment_tx[0]);
4909         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4910         check_spends!(node_txn[1], chan_1.3);
4911         check_spends!(node_txn[2], node_txn[1]);
4912
4913         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4914         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4915         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4916
4917         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4918         assert_eq!(spend_txn.len(), 1);
4919         check_spends!(spend_txn[0], node_txn[0]);
4920 }
4921
4922 #[test]
4923 fn test_static_spendable_outputs_timeout_tx() {
4924         let chanmon_cfgs = create_chanmon_cfgs(2);
4925         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4926         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4927         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4928
4929         // Create some initial channels
4930         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4931
4932         // Rebalance the network a bit by relaying one payment through all the channels ...
4933         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4934
4935         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4936
4937         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4938         assert_eq!(commitment_tx[0].input.len(), 1);
4939         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4940
4941         // Settle A's commitment tx on B' chain
4942         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4943         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4944         check_added_monitors!(nodes[1], 1);
4945         let events = nodes[1].node.get_and_clear_pending_msg_events();
4946         match events[0] {
4947                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4948                 _ => panic!("Unexpected event"),
4949         }
4950
4951         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4952         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4953         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4954         check_spends!(node_txn[0],  commitment_tx[0].clone());
4955         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4956         check_spends!(node_txn[1], chan_1.3.clone());
4957         check_spends!(node_txn[2], node_txn[1]);
4958
4959         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4960         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4961         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4962         expect_payment_failed!(nodes[1], our_payment_hash, true);
4963
4964         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4965         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4966         check_spends!(spend_txn[2], node_txn[0].clone());
4967 }
4968
4969 #[test]
4970 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4971         let chanmon_cfgs = create_chanmon_cfgs(2);
4972         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4973         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4974         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4975
4976         // Create some initial channels
4977         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4978
4979         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4980         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4981         assert_eq!(revoked_local_txn[0].input.len(), 1);
4982         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4983
4984         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4985
4986         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4987         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4988         check_closed_broadcast!(nodes[1], false);
4989         check_added_monitors!(nodes[1], 1);
4990
4991         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4992         assert_eq!(node_txn.len(), 2);
4993         assert_eq!(node_txn[0].input.len(), 2);
4994         check_spends!(node_txn[0], revoked_local_txn[0]);
4995
4996         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4997         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4998         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4999
5000         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5001         assert_eq!(spend_txn.len(), 1);
5002         check_spends!(spend_txn[0], node_txn[0]);
5003 }
5004
5005 #[test]
5006 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5007         let chanmon_cfgs = create_chanmon_cfgs(2);
5008         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5009         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5010         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5011
5012         // Create some initial channels
5013         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5014
5015         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5016         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5017         assert_eq!(revoked_local_txn[0].input.len(), 1);
5018         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5019
5020         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5021
5022         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5023         // A will generate HTLC-Timeout from revoked commitment tx
5024         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5025         check_closed_broadcast!(nodes[0], false);
5026         check_added_monitors!(nodes[0], 1);
5027
5028         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5029         assert_eq!(revoked_htlc_txn.len(), 2);
5030         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5031         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5032         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5033         check_spends!(revoked_htlc_txn[1], chan_1.3);
5034
5035         // B will generate justice tx from A's revoked commitment/HTLC tx
5036         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
5037         check_closed_broadcast!(nodes[1], false);
5038         check_added_monitors!(nodes[1], 1);
5039
5040         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5041         assert_eq!(node_txn.len(), 4); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-timeout, adjusted justice tx, ChannelManager: local commitment tx
5042         assert_eq!(node_txn[0].input.len(), 2);
5043         check_spends!(node_txn[0], revoked_local_txn[0]);
5044         check_spends!(node_txn[1], chan_1.3);
5045         assert_eq!(node_txn[2].input.len(), 1);
5046         check_spends!(node_txn[2], revoked_htlc_txn[0]);
5047         assert_eq!(node_txn[3].input.len(), 1);
5048         check_spends!(node_txn[3], revoked_local_txn[0]);
5049
5050         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5051         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5052         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5053
5054         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5055         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5056         assert_eq!(spend_txn.len(), 2);
5057         check_spends!(spend_txn[0], node_txn[0]);
5058         check_spends!(spend_txn[1], node_txn[2]);
5059 }
5060
5061 #[test]
5062 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5063         let chanmon_cfgs = create_chanmon_cfgs(2);
5064         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5065         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5066         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5067
5068         // Create some initial channels
5069         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5070
5071         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5072         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5073         assert_eq!(revoked_local_txn[0].input.len(), 1);
5074         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5075
5076         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5077
5078         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5079         // B will generate HTLC-Success from revoked commitment tx
5080         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5081         check_closed_broadcast!(nodes[1], false);
5082         check_added_monitors!(nodes[1], 1);
5083         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5084
5085         assert_eq!(revoked_htlc_txn.len(), 2);
5086         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5087         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5088         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5089
5090         // A will generate justice tx from B's revoked commitment/HTLC tx
5091         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5092         check_closed_broadcast!(nodes[0], false);
5093         check_added_monitors!(nodes[0], 1);
5094
5095         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5096         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5097         assert_eq!(node_txn[2].input.len(), 1);
5098         check_spends!(node_txn[2], revoked_htlc_txn[0]);
5099
5100         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5101         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5102         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5103
5104         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5105         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5106         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
5107         assert_eq!(spend_txn[0], spend_txn[1]);
5108         assert_eq!(spend_txn[0], spend_txn[2]);
5109         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5110         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
5111         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
5112 }
5113
5114 #[test]
5115 fn test_onchain_to_onchain_claim() {
5116         // Test that in case of channel closure, we detect the state of output thanks to
5117         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
5118         // First, have C claim an HTLC against its own latest commitment transaction.
5119         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5120         // channel.
5121         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5122         // gets broadcast.
5123
5124         let chanmon_cfgs = create_chanmon_cfgs(3);
5125         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5126         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5127         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5128
5129         // Create some initial channels
5130         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5131         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5132
5133         // Rebalance the network a bit by relaying one payment through all the channels ...
5134         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5135         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5136
5137         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5138         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5139         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5140         check_spends!(commitment_tx[0], chan_2.3);
5141         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5142         check_added_monitors!(nodes[2], 1);
5143         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5144         assert!(updates.update_add_htlcs.is_empty());
5145         assert!(updates.update_fail_htlcs.is_empty());
5146         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5147         assert!(updates.update_fail_malformed_htlcs.is_empty());
5148
5149         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5150         check_closed_broadcast!(nodes[2], false);
5151         check_added_monitors!(nodes[2], 1);
5152
5153         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5154         assert_eq!(c_txn.len(), 3);
5155         assert_eq!(c_txn[0], c_txn[2]);
5156         assert_eq!(commitment_tx[0], c_txn[1]);
5157         check_spends!(c_txn[1], chan_2.3);
5158         check_spends!(c_txn[2], c_txn[1]);
5159         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5160         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5161         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5162         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5163
5164         // 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
5165         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5166         {
5167                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5168                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5169                 assert_eq!(b_txn.len(), 3);
5170                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5171                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5172                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5173                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5174                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5175                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
5176                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5177                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5178                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5179                 b_txn.clear();
5180         }
5181         check_added_monitors!(nodes[1], 1);
5182         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5183         check_added_monitors!(nodes[1], 1);
5184         match msg_events[0] {
5185                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
5186                 _ => panic!("Unexpected event"),
5187         }
5188         match msg_events[1] {
5189                 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, .. } } => {
5190                         assert!(update_add_htlcs.is_empty());
5191                         assert!(update_fail_htlcs.is_empty());
5192                         assert_eq!(update_fulfill_htlcs.len(), 1);
5193                         assert!(update_fail_malformed_htlcs.is_empty());
5194                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5195                 },
5196                 _ => panic!("Unexpected event"),
5197         };
5198         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5199         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5200         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5201         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5202         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5203         assert_eq!(b_txn.len(), 3);
5204         check_spends!(b_txn[1], chan_1.3);
5205         check_spends!(b_txn[2], b_txn[1]);
5206         check_spends!(b_txn[0], commitment_tx[0]);
5207         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5208         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5209         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5210
5211         check_closed_broadcast!(nodes[1], false);
5212         check_added_monitors!(nodes[1], 1);
5213 }
5214
5215 #[test]
5216 fn test_duplicate_payment_hash_one_failure_one_success() {
5217         // Topology : A --> B --> C
5218         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5219         let chanmon_cfgs = create_chanmon_cfgs(3);
5220         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5221         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5222         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5223
5224         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5225         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5226
5227         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5228         *nodes[0].network_payment_count.borrow_mut() -= 1;
5229         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5230
5231         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5232         assert_eq!(commitment_txn[0].input.len(), 1);
5233         check_spends!(commitment_txn[0], chan_2.3);
5234
5235         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5236         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5237         check_closed_broadcast!(nodes[1], false);
5238         check_added_monitors!(nodes[1], 1);
5239
5240         let htlc_timeout_tx;
5241         { // Extract one of the two HTLC-Timeout transaction
5242                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5243                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5244                 assert_eq!(node_txn.len(), 5);
5245                 check_spends!(node_txn[0], commitment_txn[0]);
5246                 assert_eq!(node_txn[0].input.len(), 1);
5247                 check_spends!(node_txn[1], commitment_txn[0]);
5248                 assert_eq!(node_txn[1].input.len(), 1);
5249                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5250                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5251                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5252                 check_spends!(node_txn[2], chan_2.3);
5253                 check_spends!(node_txn[3], node_txn[2]);
5254                 check_spends!(node_txn[4], node_txn[2]);
5255                 htlc_timeout_tx = node_txn[1].clone();
5256         }
5257
5258         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5259         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5260         check_added_monitors!(nodes[2], 3);
5261         let events = nodes[2].node.get_and_clear_pending_msg_events();
5262         match events[0] {
5263                 MessageSendEvent::UpdateHTLCs { .. } => {},
5264                 _ => panic!("Unexpected event"),
5265         }
5266         match events[1] {
5267                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5268                 _ => panic!("Unexepected event"),
5269         }
5270         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5271         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)
5272         check_spends!(htlc_success_txn[2], chan_2.3);
5273         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5274         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5275         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5276         assert_eq!(htlc_success_txn[0].input.len(), 1);
5277         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5278         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5279         assert_eq!(htlc_success_txn[1].input.len(), 1);
5280         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5281         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5282         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5283         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5284
5285         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5286         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
5287         expect_pending_htlcs_forwardable!(nodes[1]);
5288         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5289         assert!(htlc_updates.update_add_htlcs.is_empty());
5290         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5291         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5292         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5293         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5294         check_added_monitors!(nodes[1], 1);
5295
5296         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5297         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5298         {
5299                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5300                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5301                 assert_eq!(events.len(), 1);
5302                 match events[0] {
5303                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5304                         },
5305                         _ => { panic!("Unexpected event"); }
5306                 }
5307         }
5308         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5309
5310         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5311         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5312         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5313         assert!(updates.update_add_htlcs.is_empty());
5314         assert!(updates.update_fail_htlcs.is_empty());
5315         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5316         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5317         assert!(updates.update_fail_malformed_htlcs.is_empty());
5318         check_added_monitors!(nodes[1], 1);
5319
5320         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5321         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5322
5323         let events = nodes[0].node.get_and_clear_pending_events();
5324         match events[0] {
5325                 Event::PaymentSent { ref payment_preimage } => {
5326                         assert_eq!(*payment_preimage, our_payment_preimage);
5327                 }
5328                 _ => panic!("Unexpected event"),
5329         }
5330 }
5331
5332 #[test]
5333 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5334         let chanmon_cfgs = create_chanmon_cfgs(2);
5335         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5336         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5337         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5338
5339         // Create some initial channels
5340         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5341
5342         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5343         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5344         assert_eq!(local_txn[0].input.len(), 1);
5345         check_spends!(local_txn[0], chan_1.3);
5346
5347         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5348         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5349         check_added_monitors!(nodes[1], 1);
5350         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5351         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5352         check_added_monitors!(nodes[1], 1);
5353         let events = nodes[1].node.get_and_clear_pending_msg_events();
5354         match events[0] {
5355                 MessageSendEvent::UpdateHTLCs { .. } => {},
5356                 _ => panic!("Unexpected event"),
5357         }
5358         match events[1] {
5359                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5360                 _ => panic!("Unexepected event"),
5361         }
5362         let node_txn = {
5363                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5364                 assert_eq!(node_txn[0].input.len(), 1);
5365                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5366                 check_spends!(node_txn[0], local_txn[0]);
5367                 vec![node_txn[0].clone(), node_txn[2].clone()]
5368         };
5369
5370         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5371         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
5372         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5373
5374         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5375         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5376         assert_eq!(spend_txn.len(), 2);
5377         check_spends!(spend_txn[0], node_txn[0]);
5378         check_spends!(spend_txn[1], node_txn[1]);
5379 }
5380
5381 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5382         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5383         // unrevoked commitment transaction.
5384         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5385         // a remote RAA before they could be failed backwards (and combinations thereof).
5386         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5387         // use the same payment hashes.
5388         // Thus, we use a six-node network:
5389         //
5390         // A \         / E
5391         //    - C - D -
5392         // B /         \ F
5393         // And test where C fails back to A/B when D announces its latest commitment transaction
5394         let chanmon_cfgs = create_chanmon_cfgs(6);
5395         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5396         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5397         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5398         let logger = test_utils::TestLogger::new();
5399
5400         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5401         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5402         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5403         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5404         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5405
5406         // Rebalance and check output sanity...
5407         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5408         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5409         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5410
5411         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5412         // 0th HTLC:
5413         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
5414         // 1st HTLC:
5415         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
5416         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5417         let our_node_id = &nodes[1].node.get_our_node_id();
5418         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5419         // 2nd HTLC:
5420         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_1); // not added < dust limit + HTLC tx fee
5421         // 3rd HTLC:
5422         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_2); // not added < dust limit + HTLC tx fee
5423         // 4th HTLC:
5424         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5425         // 5th HTLC:
5426         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5427         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5428         // 6th HTLC:
5429         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5430         // 7th HTLC:
5431         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5432
5433         // 8th HTLC:
5434         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5435         // 9th HTLC:
5436         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV, &logger).unwrap();
5437         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], ds_dust_limit*1000, payment_hash_5); // not added < dust limit + HTLC tx fee
5438
5439         // 10th HTLC:
5440         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
5441         // 11th HTLC:
5442         let route = get_route(our_node_id, &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
5443         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5444
5445         // Double-check that six of the new HTLC were added
5446         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5447         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5448         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5449         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5450
5451         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5452         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5453         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5454         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5455         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5456         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5457         check_added_monitors!(nodes[4], 0);
5458         expect_pending_htlcs_forwardable!(nodes[4]);
5459         check_added_monitors!(nodes[4], 1);
5460
5461         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5462         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5463         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5464         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5465         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5466         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5467
5468         // Fail 3rd below-dust and 7th above-dust HTLCs
5469         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5470         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5471         check_added_monitors!(nodes[5], 0);
5472         expect_pending_htlcs_forwardable!(nodes[5]);
5473         check_added_monitors!(nodes[5], 1);
5474
5475         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5476         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5477         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5478         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5479
5480         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5481
5482         expect_pending_htlcs_forwardable!(nodes[3]);
5483         check_added_monitors!(nodes[3], 1);
5484         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5485         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5486         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5487         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5488         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5489         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5490         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5491         if deliver_last_raa {
5492                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5493         } else {
5494                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5495         }
5496
5497         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5498         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5499         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5500         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5501         //
5502         // We now broadcast the latest commitment transaction, which *should* result in failures for
5503         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5504         // the non-broadcast above-dust HTLCs.
5505         //
5506         // Alternatively, we may broadcast the previous commitment transaction, which should only
5507         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5508         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5509
5510         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5511         if announce_latest {
5512                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
5513         } else {
5514                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
5515         }
5516         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
5517         check_closed_broadcast!(nodes[2], false);
5518         expect_pending_htlcs_forwardable!(nodes[2]);
5519         check_added_monitors!(nodes[2], 3);
5520
5521         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5522         assert_eq!(cs_msgs.len(), 2);
5523         let mut a_done = false;
5524         for msg in cs_msgs {
5525                 match msg {
5526                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5527                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5528                                 // should be failed-backwards here.
5529                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5530                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5531                                         for htlc in &updates.update_fail_htlcs {
5532                                                 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 });
5533                                         }
5534                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5535                                         assert!(!a_done);
5536                                         a_done = true;
5537                                         &nodes[0]
5538                                 } else {
5539                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5540                                         for htlc in &updates.update_fail_htlcs {
5541                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5542                                         }
5543                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5544                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5545                                         &nodes[1]
5546                                 };
5547                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5548                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5549                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5550                                 if announce_latest {
5551                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5552                                         if *node_id == nodes[0].node.get_our_node_id() {
5553                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5554                                         }
5555                                 }
5556                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5557                         },
5558                         _ => panic!("Unexpected event"),
5559                 }
5560         }
5561
5562         let as_events = nodes[0].node.get_and_clear_pending_events();
5563         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5564         let mut as_failds = HashSet::new();
5565         for event in as_events.iter() {
5566                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5567                         assert!(as_failds.insert(*payment_hash));
5568                         if *payment_hash != payment_hash_2 {
5569                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5570                         } else {
5571                                 assert!(!rejected_by_dest);
5572                         }
5573                 } else { panic!("Unexpected event"); }
5574         }
5575         assert!(as_failds.contains(&payment_hash_1));
5576         assert!(as_failds.contains(&payment_hash_2));
5577         if announce_latest {
5578                 assert!(as_failds.contains(&payment_hash_3));
5579                 assert!(as_failds.contains(&payment_hash_5));
5580         }
5581         assert!(as_failds.contains(&payment_hash_6));
5582
5583         let bs_events = nodes[1].node.get_and_clear_pending_events();
5584         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5585         let mut bs_failds = HashSet::new();
5586         for event in bs_events.iter() {
5587                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5588                         assert!(bs_failds.insert(*payment_hash));
5589                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5590                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5591                         } else {
5592                                 assert!(!rejected_by_dest);
5593                         }
5594                 } else { panic!("Unexpected event"); }
5595         }
5596         assert!(bs_failds.contains(&payment_hash_1));
5597         assert!(bs_failds.contains(&payment_hash_2));
5598         if announce_latest {
5599                 assert!(bs_failds.contains(&payment_hash_4));
5600         }
5601         assert!(bs_failds.contains(&payment_hash_5));
5602
5603         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5604         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5605         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5606         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5607         // PaymentFailureNetworkUpdates.
5608         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5609         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5610         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5611         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5612         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5613                 match event {
5614                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5615                         _ => panic!("Unexpected event"),
5616                 }
5617         }
5618 }
5619
5620 #[test]
5621 fn test_fail_backwards_latest_remote_announce_a() {
5622         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5623 }
5624
5625 #[test]
5626 fn test_fail_backwards_latest_remote_announce_b() {
5627         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5628 }
5629
5630 #[test]
5631 fn test_fail_backwards_previous_remote_announce() {
5632         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5633         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5634         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5635 }
5636
5637 #[test]
5638 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5639         let chanmon_cfgs = create_chanmon_cfgs(2);
5640         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5641         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5642         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5643
5644         // Create some initial channels
5645         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5646
5647         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5648         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5649         assert_eq!(local_txn[0].input.len(), 1);
5650         check_spends!(local_txn[0], chan_1.3);
5651
5652         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5653         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5654         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5655         check_closed_broadcast!(nodes[0], false);
5656         check_added_monitors!(nodes[0], 1);
5657
5658         let htlc_timeout = {
5659                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5660                 assert_eq!(node_txn[0].input.len(), 1);
5661                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5662                 check_spends!(node_txn[0], local_txn[0]);
5663                 node_txn[0].clone()
5664         };
5665
5666         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5667         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5668         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5669         expect_payment_failed!(nodes[0], our_payment_hash, true);
5670
5671         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5672         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5673         assert_eq!(spend_txn.len(), 3);
5674         assert_eq!(spend_txn[0], spend_txn[1]);
5675         check_spends!(spend_txn[0], local_txn[0]);
5676         check_spends!(spend_txn[2], htlc_timeout);
5677 }
5678
5679 #[test]
5680 fn test_key_derivation_params() {
5681         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5682         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5683         // let us re-derive the channel key set to then derive a delayed_payment_key.
5684
5685         let chanmon_cfgs = create_chanmon_cfgs(3);
5686
5687         // We manually create the node configuration to backup the seed.
5688         let seed = [42; 32];
5689         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5690         let chan_monitor = test_utils::TestChannelMonitor::new(&chanmon_cfgs[0].chain_monitor, &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator);
5691         let node = NodeCfg { chain_monitor: &chanmon_cfgs[0].chain_monitor, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, chan_monitor, keys_manager, node_seed: seed };
5692         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5693         node_cfgs.remove(0);
5694         node_cfgs.insert(0, node);
5695
5696         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5697         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5698
5699         // Create some initial channels
5700         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5701         // for node 0
5702         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5703         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5704         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5705
5706         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5707         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5708         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5709         assert_eq!(local_txn_1[0].input.len(), 1);
5710         check_spends!(local_txn_1[0], chan_1.3);
5711
5712         // We check funding pubkey are unique
5713         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]));
5714         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]));
5715         if from_0_funding_key_0 == from_1_funding_key_0
5716             || from_0_funding_key_0 == from_1_funding_key_1
5717             || from_0_funding_key_1 == from_1_funding_key_0
5718             || from_0_funding_key_1 == from_1_funding_key_1 {
5719                 panic!("Funding pubkeys aren't unique");
5720         }
5721
5722         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5723         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5724         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn_1[0].clone()] }, 200);
5725         check_closed_broadcast!(nodes[0], false);
5726         check_added_monitors!(nodes[0], 1);
5727
5728         let htlc_timeout = {
5729                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5730                 assert_eq!(node_txn[0].input.len(), 1);
5731                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5732                 check_spends!(node_txn[0], local_txn_1[0]);
5733                 node_txn[0].clone()
5734         };
5735
5736         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5737         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5738         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5739         expect_payment_failed!(nodes[0], our_payment_hash, true);
5740
5741         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5742         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5743         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5744         assert_eq!(spend_txn.len(), 3);
5745         assert_eq!(spend_txn[0], spend_txn[1]);
5746         check_spends!(spend_txn[0], local_txn_1[0]);
5747         check_spends!(spend_txn[2], htlc_timeout);
5748 }
5749
5750 #[test]
5751 fn test_static_output_closing_tx() {
5752         let chanmon_cfgs = create_chanmon_cfgs(2);
5753         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5754         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5755         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5756
5757         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5758
5759         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5760         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5761
5762         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5763         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5764         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5765
5766         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5767         assert_eq!(spend_txn.len(), 1);
5768         check_spends!(spend_txn[0], closing_tx);
5769
5770         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5771         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5772
5773         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5774         assert_eq!(spend_txn.len(), 1);
5775         check_spends!(spend_txn[0], closing_tx);
5776 }
5777
5778 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5779         let chanmon_cfgs = create_chanmon_cfgs(2);
5780         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5781         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5782         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5783         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5784
5785         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5786
5787         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5788         // present in B's local commitment transaction, but none of A's commitment transactions.
5789         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5790         check_added_monitors!(nodes[1], 1);
5791
5792         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5793         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5794         let events = nodes[0].node.get_and_clear_pending_events();
5795         assert_eq!(events.len(), 1);
5796         match events[0] {
5797                 Event::PaymentSent { payment_preimage } => {
5798                         assert_eq!(payment_preimage, our_payment_preimage);
5799                 },
5800                 _ => panic!("Unexpected event"),
5801         }
5802
5803         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5804         check_added_monitors!(nodes[0], 1);
5805         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5806         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5807         check_added_monitors!(nodes[1], 1);
5808
5809         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5810         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5811                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5812                 header.prev_blockhash = header.bitcoin_hash();
5813         }
5814         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5815         check_closed_broadcast!(nodes[1], false);
5816         check_added_monitors!(nodes[1], 1);
5817 }
5818
5819 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5820         let chanmon_cfgs = create_chanmon_cfgs(2);
5821         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5822         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5823         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5824         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5825         let logger = test_utils::TestLogger::new();
5826
5827         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5828         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5829         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(), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV, &logger).unwrap();
5830         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5831         check_added_monitors!(nodes[0], 1);
5832
5833         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5834
5835         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5836         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5837         // to "time out" the HTLC.
5838
5839         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5840
5841         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5842                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5843                 header.prev_blockhash = header.bitcoin_hash();
5844         }
5845         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5846         check_closed_broadcast!(nodes[0], false);
5847         check_added_monitors!(nodes[0], 1);
5848 }
5849
5850 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5851         let chanmon_cfgs = create_chanmon_cfgs(3);
5852         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5853         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5854         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5855         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5856
5857         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5858         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5859         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5860         // actually revoked.
5861         let htlc_value = if use_dust { 50000 } else { 3000000 };
5862         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5863         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5864         expect_pending_htlcs_forwardable!(nodes[1]);
5865         check_added_monitors!(nodes[1], 1);
5866
5867         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5868         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5869         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5870         check_added_monitors!(nodes[0], 1);
5871         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5872         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5873         check_added_monitors!(nodes[1], 1);
5874         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5875         check_added_monitors!(nodes[1], 1);
5876         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5877
5878         if check_revoke_no_close {
5879                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5880                 check_added_monitors!(nodes[0], 1);
5881         }
5882
5883         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5884         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5885                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5886                 header.prev_blockhash = header.bitcoin_hash();
5887         }
5888         if !check_revoke_no_close {
5889                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5890                 check_closed_broadcast!(nodes[0], false);
5891                 check_added_monitors!(nodes[0], 1);
5892         } else {
5893                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5894         }
5895 }
5896
5897 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5898 // There are only a few cases to test here:
5899 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5900 //    broadcastable commitment transactions result in channel closure,
5901 //  * its included in an unrevoked-but-previous remote commitment transaction,
5902 //  * its included in the latest remote or local commitment transactions.
5903 // We test each of the three possible commitment transactions individually and use both dust and
5904 // non-dust HTLCs.
5905 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5906 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5907 // tested for at least one of the cases in other tests.
5908 #[test]
5909 fn htlc_claim_single_commitment_only_a() {
5910         do_htlc_claim_local_commitment_only(true);
5911         do_htlc_claim_local_commitment_only(false);
5912
5913         do_htlc_claim_current_remote_commitment_only(true);
5914         do_htlc_claim_current_remote_commitment_only(false);
5915 }
5916
5917 #[test]
5918 fn htlc_claim_single_commitment_only_b() {
5919         do_htlc_claim_previous_remote_commitment_only(true, false);
5920         do_htlc_claim_previous_remote_commitment_only(false, false);
5921         do_htlc_claim_previous_remote_commitment_only(true, true);
5922         do_htlc_claim_previous_remote_commitment_only(false, true);
5923 }
5924
5925 fn run_onion_failure_test<F1,F2>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, callback_msg: F1, callback_node: F2, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
5926         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5927                                 F2: FnMut(),
5928 {
5929         run_onion_failure_test_with_fail_intercept(_name, test_case, nodes, route, payment_hash, callback_msg, |_|{}, callback_node, expected_retryable, expected_error_code, expected_channel_update);
5930 }
5931
5932 // test_case
5933 // 0: node1 fails backward
5934 // 1: final node fails backward
5935 // 2: payment completed but the user rejects the payment
5936 // 3: final node fails backward (but tamper onion payloads from node0)
5937 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5938 // 200: trigger error in the final node and tamper returning fail_htlc
5939 fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, mut callback_msg: F1, mut callback_fail: F2, mut callback_node: F3, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
5940         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5941                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5942                                 F3: FnMut(),
5943 {
5944
5945         // reset block height
5946         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5947         for ix in 0..nodes.len() {
5948                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5949         }
5950
5951         macro_rules! expect_event {
5952                 ($node: expr, $event_type: path) => {{
5953                         let events = $node.node.get_and_clear_pending_events();
5954                         assert_eq!(events.len(), 1);
5955                         match events[0] {
5956                                 $event_type { .. } => {},
5957                                 _ => panic!("Unexpected event"),
5958                         }
5959                 }}
5960         }
5961
5962         macro_rules! expect_htlc_forward {
5963                 ($node: expr) => {{
5964                         expect_event!($node, Event::PendingHTLCsForwardable);
5965                         $node.node.process_pending_htlc_forwards();
5966                 }}
5967         }
5968
5969         // 0 ~~> 2 send payment
5970         nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5971         check_added_monitors!(nodes[0], 1);
5972         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5973         // temper update_add (0 => 1)
5974         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5975         if test_case == 0 || test_case == 3 || test_case == 100 {
5976                 callback_msg(&mut update_add_0);
5977                 callback_node();
5978         }
5979         // 0 => 1 update_add & CS
5980         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5981         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5982
5983         let update_1_0 = match test_case {
5984                 0|100 => { // intermediate node failure; fail backward to 0
5985                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5986                         assert!(update_1_0.update_fail_htlcs.len()+update_1_0.update_fail_malformed_htlcs.len()==1 && (update_1_0.update_fail_htlcs.len()==1 || update_1_0.update_fail_malformed_htlcs.len()==1));
5987                         update_1_0
5988                 },
5989                 1|2|3|200 => { // final node failure; forwarding to 2
5990                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5991                         // forwarding on 1
5992                         if test_case != 200 {
5993                                 callback_node();
5994                         }
5995                         expect_htlc_forward!(&nodes[1]);
5996
5997                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5998                         check_added_monitors!(&nodes[1], 1);
5999                         assert_eq!(update_1.update_add_htlcs.len(), 1);
6000                         // tamper update_add (1 => 2)
6001                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
6002                         if test_case != 3 && test_case != 200 {
6003                                 callback_msg(&mut update_add_1);
6004                         }
6005
6006                         // 1 => 2
6007                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
6008                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
6009
6010                         if test_case == 2 || test_case == 200 {
6011                                 expect_htlc_forward!(&nodes[2]);
6012                                 expect_event!(&nodes[2], Event::PaymentReceived);
6013                                 callback_node();
6014                                 expect_pending_htlcs_forwardable!(nodes[2]);
6015                         }
6016
6017                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6018                         if test_case == 2 || test_case == 200 {
6019                                 check_added_monitors!(&nodes[2], 1);
6020                         }
6021                         assert!(update_2_1.update_fail_htlcs.len() == 1);
6022
6023                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
6024                         if test_case == 200 {
6025                                 callback_fail(&mut fail_msg);
6026                         }
6027
6028                         // 2 => 1
6029                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
6030                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
6031
6032                         // backward fail on 1
6033                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6034                         assert!(update_1_0.update_fail_htlcs.len() == 1);
6035                         update_1_0
6036                 },
6037                 _ => unreachable!(),
6038         };
6039
6040         // 1 => 0 commitment_signed_dance
6041         if update_1_0.update_fail_htlcs.len() > 0 {
6042                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
6043                 if test_case == 100 {
6044                         callback_fail(&mut fail_msg);
6045                 }
6046                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6047         } else {
6048                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
6049         };
6050
6051         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
6052
6053         let events = nodes[0].node.get_and_clear_pending_events();
6054         assert_eq!(events.len(), 1);
6055         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, error_data: _ } = &events[0] {
6056                 assert_eq!(*rejected_by_dest, !expected_retryable);
6057                 assert_eq!(*error_code, expected_error_code);
6058         } else {
6059                 panic!("Uexpected event");
6060         }
6061
6062         let events = nodes[0].node.get_and_clear_pending_msg_events();
6063         if expected_channel_update.is_some() {
6064                 assert_eq!(events.len(), 1);
6065                 match events[0] {
6066                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
6067                                 match update {
6068                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
6069                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
6070                                                         panic!("channel_update not found!");
6071                                                 }
6072                                         },
6073                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
6074                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6075                                                         assert!(*short_channel_id == *expected_short_channel_id);
6076                                                         assert!(*is_permanent == *expected_is_permanent);
6077                                                 } else {
6078                                                         panic!("Unexpected message event");
6079                                                 }
6080                                         },
6081                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
6082                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6083                                                         assert!(*node_id == *expected_node_id);
6084                                                         assert!(*is_permanent == *expected_is_permanent);
6085                                                 } else {
6086                                                         panic!("Unexpected message event");
6087                                                 }
6088                                         },
6089                                 }
6090                         },
6091                         _ => panic!("Unexpected message event"),
6092                 }
6093         } else {
6094                 assert_eq!(events.len(), 0);
6095         }
6096 }
6097
6098 impl msgs::ChannelUpdate {
6099         fn dummy() -> msgs::ChannelUpdate {
6100                 use bitcoin::secp256k1::ffi::Signature as FFISignature;
6101                 use bitcoin::secp256k1::Signature;
6102                 msgs::ChannelUpdate {
6103                         signature: Signature::from(FFISignature::new()),
6104                         contents: msgs::UnsignedChannelUpdate {
6105                                 chain_hash: BlockHash::hash(&vec![0u8][..]),
6106                                 short_channel_id: 0,
6107                                 timestamp: 0,
6108                                 flags: 0,
6109                                 cltv_expiry_delta: 0,
6110                                 htlc_minimum_msat: 0,
6111                                 htlc_maximum_msat: OptionalField::Absent,
6112                                 fee_base_msat: 0,
6113                                 fee_proportional_millionths: 0,
6114                                 excess_data: vec![],
6115                         }
6116                 }
6117         }
6118 }
6119
6120 struct BogusOnionHopData {
6121         data: Vec<u8>
6122 }
6123 impl BogusOnionHopData {
6124         fn new(orig: msgs::OnionHopData) -> Self {
6125                 Self { data: orig.encode() }
6126         }
6127 }
6128 impl Writeable for BogusOnionHopData {
6129         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6130                 writer.write_all(&self.data[..])
6131         }
6132 }
6133
6134 #[test]
6135 fn test_onion_failure() {
6136         use ln::msgs::ChannelUpdate;
6137         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
6138         use bitcoin::secp256k1;
6139
6140         const BADONION: u16 = 0x8000;
6141         const PERM: u16 = 0x4000;
6142         const NODE: u16 = 0x2000;
6143         const UPDATE: u16 = 0x1000;
6144
6145         let chanmon_cfgs = create_chanmon_cfgs(3);
6146         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6147         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6148         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6149         for node in nodes.iter() {
6150                 *node.keys_manager.override_session_priv.lock().unwrap() = Some([3; 32]);
6151         }
6152         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known())];
6153         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
6154         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6155         let logger = test_utils::TestLogger::new();
6156         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(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap();
6157         // positve case
6158         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
6159
6160         // intermediate node failure
6161         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
6162                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6163                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6164                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6165                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6166                 let mut new_payloads = Vec::new();
6167                 for payload in onion_payloads.drain(..) {
6168                         new_payloads.push(BogusOnionHopData::new(payload));
6169                 }
6170                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
6171                 // describing a length-1 TLV payload, which is obviously bogus.
6172                 new_payloads[0].data[0] = 1;
6173                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6174         }, ||{}, true, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
6175
6176         // final node failure
6177         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
6178                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6179                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6180                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6181                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6182                 let mut new_payloads = Vec::new();
6183                 for payload in onion_payloads.drain(..) {
6184                         new_payloads.push(BogusOnionHopData::new(payload));
6185                 }
6186                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
6187                 // length-1 TLV payload, which is obviously bogus.
6188                 new_payloads[1].data[0] = 1;
6189                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6190         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6191
6192         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
6193         // receiving simulated fail messages
6194         // intermediate node failure
6195         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6196                 // trigger error
6197                 msg.amount_msat -= 1;
6198         }, |msg| {
6199                 // and tamper returning error message
6200                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6201                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6202                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
6203         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
6204
6205         // final node failure
6206         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6207                 // and tamper returning error message
6208                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6209                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6210                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
6211         }, ||{
6212                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6213         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
6214
6215         // intermediate node failure
6216         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6217                 msg.amount_msat -= 1;
6218         }, |msg| {
6219                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6220                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6221                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
6222         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6223
6224         // final node failure
6225         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6226                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6227                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6228                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
6229         }, ||{
6230                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6231         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6232
6233         // intermediate node failure
6234         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6235                 msg.amount_msat -= 1;
6236         }, |msg| {
6237                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6238                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6239                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
6240         }, ||{
6241                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6242         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6243
6244         // final node failure
6245         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6246                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6247                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6248                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
6249         }, ||{
6250                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6251         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6252
6253         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
6254                 Some(BADONION|PERM|4), None);
6255
6256         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
6257                 Some(BADONION|PERM|5), None);
6258
6259         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
6260                 Some(BADONION|PERM|6), None);
6261
6262         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6263                 msg.amount_msat -= 1;
6264         }, |msg| {
6265                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6266                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6267                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
6268         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6269
6270         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6271                 msg.amount_msat -= 1;
6272         }, |msg| {
6273                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6274                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6275                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
6276                 // short_channel_id from the processing node
6277         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6278
6279         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6280                 msg.amount_msat -= 1;
6281         }, |msg| {
6282                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6283                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6284                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
6285                 // short_channel_id from the processing node
6286         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6287
6288         let mut bogus_route = route.clone();
6289         bogus_route.paths[0][1].short_channel_id -= 1;
6290         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
6291           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
6292
6293         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
6294         let mut bogus_route = route.clone();
6295         let route_len = bogus_route.paths[0].len();
6296         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
6297         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6298
6299         //TODO: with new config API, we will be able to generate both valid and
6300         //invalid channel_update cases.
6301         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
6302                 msg.amount_msat -= 1;
6303         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6304
6305         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
6306                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
6307                 msg.cltv_expiry -= 1;
6308         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6309
6310         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
6311                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6312                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6313
6314                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
6315         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6316
6317         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
6318                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6319         }, false, Some(PERM|15), None);
6320
6321         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
6322                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6323                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6324
6325                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
6326         }, || {}, true, Some(17), None);
6327
6328         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
6329                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6330                         for f in pending_forwards.iter_mut() {
6331                                 match f {
6332                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6333                                                 forward_info.outgoing_cltv_value += 1,
6334                                         _ => {},
6335                                 }
6336                         }
6337                 }
6338         }, true, Some(18), None);
6339
6340         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
6341                 // violate amt_to_forward > msg.amount_msat
6342                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6343                         for f in pending_forwards.iter_mut() {
6344                                 match f {
6345                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6346                                                 forward_info.amt_to_forward -= 1,
6347                                         _ => {},
6348                                 }
6349                         }
6350                 }
6351         }, true, Some(19), None);
6352
6353         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
6354                 // disconnect event to the channel between nodes[1] ~ nodes[2]
6355                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
6356                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6357         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6358         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6359
6360         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
6361                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6362                 let mut route = route.clone();
6363                 let height = 1;
6364                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
6365                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6366                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
6367                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
6368                 msg.cltv_expiry = htlc_cltv;
6369                 msg.onion_routing_packet = onion_packet;
6370         }, ||{}, true, Some(21), None);
6371 }
6372
6373 #[test]
6374 #[should_panic]
6375 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6376         let chanmon_cfgs = create_chanmon_cfgs(2);
6377         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6378         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6379         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6380         //Force duplicate channel ids
6381         for node in nodes.iter() {
6382                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6383         }
6384
6385         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6386         let channel_value_satoshis=10000;
6387         let push_msat=10001;
6388         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6389         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6390         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6391
6392         //Create a second channel with a channel_id collision
6393         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6394 }
6395
6396 #[test]
6397 fn bolt2_open_channel_sending_node_checks_part2() {
6398         let chanmon_cfgs = create_chanmon_cfgs(2);
6399         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6400         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6401         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6402
6403         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6404         let channel_value_satoshis=2^24;
6405         let push_msat=10001;
6406         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6407
6408         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6409         let channel_value_satoshis=10000;
6410         // Test when push_msat is equal to 1000 * funding_satoshis.
6411         let push_msat=1000*channel_value_satoshis+1;
6412         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6413
6414         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6415         let channel_value_satoshis=10000;
6416         let push_msat=10001;
6417         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
6418         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6419         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6420
6421         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6422         // 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
6423         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6424
6425         // 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.
6426         assert!(BREAKDOWN_TIMEOUT>0);
6427         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6428
6429         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6430         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
6431         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6432
6433         // 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.
6434         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6435         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6436         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6437         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6438         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6439 }
6440
6441 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6442 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6443 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6444 // is no longer affordable once it's freed.
6445 #[test]
6446 fn test_fail_holding_cell_htlc_upon_free() {
6447         let chanmon_cfgs = create_chanmon_cfgs(2);
6448         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6449         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6450         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6451         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6452         let logger = test_utils::TestLogger::new();
6453
6454         // First nodes[0] generates an update_fee, setting the channel's
6455         // pending_update_fee.
6456         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6457         check_added_monitors!(nodes[0], 1);
6458
6459         let events = nodes[0].node.get_and_clear_pending_msg_events();
6460         assert_eq!(events.len(), 1);
6461         let (update_msg, commitment_signed) = match events[0] {
6462                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6463                         (update_fee.as_ref(), commitment_signed)
6464                 },
6465                 _ => panic!("Unexpected event"),
6466         };
6467
6468         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6469
6470         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6471         let channel_reserve = chan_stat.channel_reserve_msat;
6472         let feerate = get_feerate!(nodes[0], chan.2);
6473
6474         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6475         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6476         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6477         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6478         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(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6479
6480         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6481         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6482         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6483         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6484
6485         // Flush the pending fee update.
6486         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6487         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6488         check_added_monitors!(nodes[1], 1);
6489         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6490         check_added_monitors!(nodes[0], 1);
6491
6492         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6493         // HTLC, but now that the fee has been raised the payment will now fail, causing
6494         // us to surface its failure to the user.
6495         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6496         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6497         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6498         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put us under local channel reserve value ({})", log_bytes!(our_payment_hash.0), chan_stat.channel_reserve_msat);
6499         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6500
6501         // Check that the payment failed to be sent out.
6502         let events = nodes[0].node.get_and_clear_pending_events();
6503         assert_eq!(events.len(), 1);
6504         match &events[0] {
6505                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6506                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6507                         assert_eq!(*rejected_by_dest, false);
6508                         assert_eq!(*error_code, None);
6509                         assert_eq!(*error_data, None);
6510                 },
6511                 _ => panic!("Unexpected event"),
6512         }
6513 }
6514
6515 // Test that if multiple HTLCs are released from the holding cell and one is
6516 // valid but the other is no longer valid upon release, the valid HTLC can be
6517 // successfully completed while the other one fails as expected.
6518 #[test]
6519 fn test_free_and_fail_holding_cell_htlcs() {
6520         let chanmon_cfgs = create_chanmon_cfgs(2);
6521         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6522         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6523         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6524         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6525         let logger = test_utils::TestLogger::new();
6526
6527         // First nodes[0] generates an update_fee, setting the channel's
6528         // pending_update_fee.
6529         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6530         check_added_monitors!(nodes[0], 1);
6531
6532         let events = nodes[0].node.get_and_clear_pending_msg_events();
6533         assert_eq!(events.len(), 1);
6534         let (update_msg, commitment_signed) = match events[0] {
6535                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6536                         (update_fee.as_ref(), commitment_signed)
6537                 },
6538                 _ => panic!("Unexpected event"),
6539         };
6540
6541         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6542
6543         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6544         let channel_reserve = chan_stat.channel_reserve_msat;
6545         let feerate = get_feerate!(nodes[0], chan.2);
6546
6547         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6548         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6549         let amt_1 = 20000;
6550         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6551         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6552         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6553         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(), None, &[], amt_1, TEST_FINAL_CLTV, &logger).unwrap();
6554         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(), None, &[], amt_2, TEST_FINAL_CLTV, &logger).unwrap();
6555
6556         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6557         nodes[0].node.send_payment(&route_1, payment_hash_1, &None).unwrap();
6558         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6559         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6560         nodes[0].node.send_payment(&route_2, payment_hash_2, &None).unwrap();
6561         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6562         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6563
6564         // Flush the pending fee update.
6565         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6566         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6567         check_added_monitors!(nodes[1], 1);
6568         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6569         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6570         check_added_monitors!(nodes[0], 2);
6571
6572         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6573         // but now that the fee has been raised the second payment will now fail, causing us
6574         // to surface its failure to the user. The first payment should succeed.
6575         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6576         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6577         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6578         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put us under local channel reserve value ({})", log_bytes!(payment_hash_2.0), chan_stat.channel_reserve_msat);
6579         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6580
6581         // Check that the second payment failed to be sent out.
6582         let events = nodes[0].node.get_and_clear_pending_events();
6583         assert_eq!(events.len(), 1);
6584         match &events[0] {
6585                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6586                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6587                         assert_eq!(*rejected_by_dest, false);
6588                         assert_eq!(*error_code, None);
6589                         assert_eq!(*error_data, None);
6590                 },
6591                 _ => panic!("Unexpected event"),
6592         }
6593
6594         // Complete the first payment and the RAA from the fee update.
6595         let (payment_event, send_raa_event) = {
6596                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6597                 assert_eq!(msgs.len(), 2);
6598                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6599         };
6600         let raa = match send_raa_event {
6601                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6602                 _ => panic!("Unexpected event"),
6603         };
6604         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6605         check_added_monitors!(nodes[1], 1);
6606         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6607         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6608         let events = nodes[1].node.get_and_clear_pending_events();
6609         assert_eq!(events.len(), 1);
6610         match events[0] {
6611                 Event::PendingHTLCsForwardable { .. } => {},
6612                 _ => panic!("Unexpected event"),
6613         }
6614         nodes[1].node.process_pending_htlc_forwards();
6615         let events = nodes[1].node.get_and_clear_pending_events();
6616         assert_eq!(events.len(), 1);
6617         match events[0] {
6618                 Event::PaymentReceived { .. } => {},
6619                 _ => panic!("Unexpected event"),
6620         }
6621         nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
6622         check_added_monitors!(nodes[1], 1);
6623         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6624         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6625         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6626         let events = nodes[0].node.get_and_clear_pending_events();
6627         assert_eq!(events.len(), 1);
6628         match events[0] {
6629                 Event::PaymentSent { ref payment_preimage } => {
6630                         assert_eq!(*payment_preimage, payment_preimage_1);
6631                 }
6632                 _ => panic!("Unexpected event"),
6633         }
6634 }
6635
6636 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6637 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6638 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6639 // once it's freed.
6640 #[test]
6641 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6642         let chanmon_cfgs = create_chanmon_cfgs(3);
6643         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6644         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6645         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6646         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6647         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6648         let logger = test_utils::TestLogger::new();
6649
6650         // First nodes[1] generates an update_fee, setting the channel's
6651         // pending_update_fee.
6652         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6653         check_added_monitors!(nodes[1], 1);
6654
6655         let events = nodes[1].node.get_and_clear_pending_msg_events();
6656         assert_eq!(events.len(), 1);
6657         let (update_msg, commitment_signed) = match events[0] {
6658                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6659                         (update_fee.as_ref(), commitment_signed)
6660                 },
6661                 _ => panic!("Unexpected event"),
6662         };
6663
6664         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6665
6666         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6667         let channel_reserve = chan_stat.channel_reserve_msat;
6668         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6669
6670         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6671         let feemsat = 239;
6672         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6673         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6674         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6675         let payment_event = {
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[2].node.get_our_node_id(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6678                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6679                 check_added_monitors!(nodes[0], 1);
6680
6681                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6682                 assert_eq!(events.len(), 1);
6683
6684                 SendEvent::from_event(events.remove(0))
6685         };
6686         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6687         check_added_monitors!(nodes[1], 0);
6688         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6689         expect_pending_htlcs_forwardable!(nodes[1]);
6690
6691         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6692         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6693
6694         // Flush the pending fee update.
6695         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6696         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6697         check_added_monitors!(nodes[2], 1);
6698         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6699         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6700         check_added_monitors!(nodes[1], 2);
6701
6702         // A final RAA message is generated to finalize the fee update.
6703         let events = nodes[1].node.get_and_clear_pending_msg_events();
6704         assert_eq!(events.len(), 1);
6705
6706         let raa_msg = match &events[0] {
6707                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6708                         msg.clone()
6709                 },
6710                 _ => panic!("Unexpected event"),
6711         };
6712
6713         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6714         check_added_monitors!(nodes[2], 1);
6715         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6716
6717         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6718         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6719         assert_eq!(process_htlc_forwards_event.len(), 1);
6720         match &process_htlc_forwards_event[0] {
6721                 &Event::PendingHTLCsForwardable { .. } => {},
6722                 _ => panic!("Unexpected event"),
6723         }
6724
6725         // In response, we call ChannelManager's process_pending_htlc_forwards
6726         nodes[1].node.process_pending_htlc_forwards();
6727         check_added_monitors!(nodes[1], 1);
6728
6729         // This causes the HTLC to be failed backwards.
6730         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6731         assert_eq!(fail_event.len(), 1);
6732         let (fail_msg, commitment_signed) = match &fail_event[0] {
6733                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6734                         assert_eq!(updates.update_add_htlcs.len(), 0);
6735                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6736                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6737                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6738                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6739                 },
6740                 _ => panic!("Unexpected event"),
6741         };
6742
6743         // Pass the failure messages back to nodes[0].
6744         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6745         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6746
6747         // Complete the HTLC failure+removal process.
6748         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6749         check_added_monitors!(nodes[0], 1);
6750         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6751         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6752         check_added_monitors!(nodes[1], 2);
6753         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6754         assert_eq!(final_raa_event.len(), 1);
6755         let raa = match &final_raa_event[0] {
6756                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6757                 _ => panic!("Unexpected event"),
6758         };
6759         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6760         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6761         assert_eq!(fail_msg_event.len(), 1);
6762         match &fail_msg_event[0] {
6763                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6764                 _ => panic!("Unexpected event"),
6765         }
6766         let failure_event = nodes[0].node.get_and_clear_pending_events();
6767         assert_eq!(failure_event.len(), 1);
6768         match &failure_event[0] {
6769                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6770                         assert!(!rejected_by_dest);
6771                 },
6772                 _ => panic!("Unexpected event"),
6773         }
6774         check_added_monitors!(nodes[0], 1);
6775 }
6776
6777 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6778 // 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.
6779 //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.
6780
6781 #[test]
6782 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6783         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6784         let chanmon_cfgs = create_chanmon_cfgs(2);
6785         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6786         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6787         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6788         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6789
6790         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6791         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6792         let logger = test_utils::TestLogger::new();
6793         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6794         route.paths[0][0].fee_msat = 100;
6795
6796         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6797                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6798         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6799         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6800 }
6801
6802 #[test]
6803 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6804         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6805         let chanmon_cfgs = create_chanmon_cfgs(2);
6806         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6807         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6808         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6809         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6810         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6811
6812         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6813         let logger = test_utils::TestLogger::new();
6814         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6815         route.paths[0][0].fee_msat = 0;
6816         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6817                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6818
6819         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6820         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6821 }
6822
6823 #[test]
6824 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6825         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6826         let chanmon_cfgs = create_chanmon_cfgs(2);
6827         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6828         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6829         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6830         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6831
6832         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6833         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6834         let logger = test_utils::TestLogger::new();
6835         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6836         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6837         check_added_monitors!(nodes[0], 1);
6838         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6839         updates.update_add_htlcs[0].amount_msat = 0;
6840
6841         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6842         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6843         check_closed_broadcast!(nodes[1], true).unwrap();
6844         check_added_monitors!(nodes[1], 1);
6845 }
6846
6847 #[test]
6848 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6849         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6850         //It is enforced when constructing a route.
6851         let chanmon_cfgs = create_chanmon_cfgs(2);
6852         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6853         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6854         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6855         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::known(), InitFeatures::known());
6856         let logger = test_utils::TestLogger::new();
6857
6858         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6859
6860         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6861         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(), None, &[], 100000000, 500000001, &logger).unwrap();
6862         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6863                 assert_eq!(err, &"Channel CLTV overflowed?"));
6864 }
6865
6866 #[test]
6867 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6868         //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.
6869         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6870         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6871         let chanmon_cfgs = create_chanmon_cfgs(2);
6872         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6873         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6874         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6875         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6876         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
6877
6878         let logger = test_utils::TestLogger::new();
6879         for i in 0..max_accepted_htlcs {
6880                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6881                 let payment_event = {
6882                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6883                         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6884                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6885                         check_added_monitors!(nodes[0], 1);
6886
6887                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6888                         assert_eq!(events.len(), 1);
6889                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6890                                 assert_eq!(htlcs[0].htlc_id, i);
6891                         } else {
6892                                 assert!(false);
6893                         }
6894                         SendEvent::from_event(events.remove(0))
6895                 };
6896                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6897                 check_added_monitors!(nodes[1], 0);
6898                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6899
6900                 expect_pending_htlcs_forwardable!(nodes[1]);
6901                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6902         }
6903         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6904         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6905         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6906         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6907                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6908
6909         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6910         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6911 }
6912
6913 #[test]
6914 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6915         //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.
6916         let chanmon_cfgs = create_chanmon_cfgs(2);
6917         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6918         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6919         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6920         let channel_value = 100000;
6921         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6922         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
6923
6924         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6925
6926         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6927         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6928         let logger = test_utils::TestLogger::new();
6929         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(), None, &[], max_in_flight+1, TEST_FINAL_CLTV, &logger).unwrap();
6930         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6931                 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)));
6932
6933         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6934         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);
6935
6936         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6937 }
6938
6939 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6940 #[test]
6941 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6942         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6943         let chanmon_cfgs = create_chanmon_cfgs(2);
6944         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6945         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6946         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6947         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6948         let htlc_minimum_msat: u64;
6949         {
6950                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6951                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6952                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
6953         }
6954
6955         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6956         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6957         let logger = test_utils::TestLogger::new();
6958         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(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV, &logger).unwrap();
6959         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6960         check_added_monitors!(nodes[0], 1);
6961         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6962         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6963         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6964         assert!(nodes[1].node.list_channels().is_empty());
6965         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6966         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()));
6967         check_added_monitors!(nodes[1], 1);
6968 }
6969
6970 #[test]
6971 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6972         //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
6973         let chanmon_cfgs = create_chanmon_cfgs(2);
6974         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6975         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6976         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6977         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6978         let logger = test_utils::TestLogger::new();
6979
6980         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6981         let channel_reserve = chan_stat.channel_reserve_msat;
6982         let feerate = get_feerate!(nodes[0], chan.2);
6983         // The 2* and +1 are for the fee spike reserve.
6984         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6985
6986         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6987         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6988         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6989         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(), None, &[], max_can_send, TEST_FINAL_CLTV, &logger).unwrap();
6990         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6991         check_added_monitors!(nodes[0], 1);
6992         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6993
6994         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6995         // at this time channel-initiatee receivers are not required to enforce that senders
6996         // respect the fee_spike_reserve.
6997         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6998         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6999
7000         assert!(nodes[1].node.list_channels().is_empty());
7001         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7002         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
7003         check_added_monitors!(nodes[1], 1);
7004 }
7005
7006 #[test]
7007 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
7008         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
7009         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
7010         let chanmon_cfgs = create_chanmon_cfgs(2);
7011         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7012         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7013         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7014         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
7015         let logger = test_utils::TestLogger::new();
7016
7017         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7018         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
7019
7020         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7021         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(), None, &[], 3999999, TEST_FINAL_CLTV, &logger).unwrap();
7022
7023         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
7024         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
7025         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
7026         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
7027
7028         let mut msg = msgs::UpdateAddHTLC {
7029                 channel_id: chan.2,
7030                 htlc_id: 0,
7031                 amount_msat: 1000,
7032                 payment_hash: our_payment_hash,
7033                 cltv_expiry: htlc_cltv,
7034                 onion_routing_packet: onion_packet.clone(),
7035         };
7036
7037         for i in 0..super::channel::OUR_MAX_HTLCS {
7038                 msg.htlc_id = i as u64;
7039                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
7040         }
7041         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
7042         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
7043
7044         assert!(nodes[1].node.list_channels().is_empty());
7045         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7046         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
7047         check_added_monitors!(nodes[1], 1);
7048 }
7049
7050 #[test]
7051 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
7052         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
7053         let chanmon_cfgs = create_chanmon_cfgs(2);
7054         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7055         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7056         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7057         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7058         let logger = test_utils::TestLogger::new();
7059
7060         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7061         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7062         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7063         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7064         check_added_monitors!(nodes[0], 1);
7065         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7066         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
7067         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7068
7069         assert!(nodes[1].node.list_channels().is_empty());
7070         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7071         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
7072         check_added_monitors!(nodes[1], 1);
7073 }
7074
7075 #[test]
7076 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
7077         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
7078         let chanmon_cfgs = create_chanmon_cfgs(2);
7079         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7080         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7081         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7082         let logger = test_utils::TestLogger::new();
7083
7084         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
7085         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7086         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7087         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7088         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7089         check_added_monitors!(nodes[0], 1);
7090         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7091         updates.update_add_htlcs[0].cltv_expiry = 500000000;
7092         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7093
7094         assert!(nodes[1].node.list_channels().is_empty());
7095         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7096         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
7097         check_added_monitors!(nodes[1], 1);
7098 }
7099
7100 #[test]
7101 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
7102         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
7103         // We test this by first testing that that repeated HTLCs pass commitment signature checks
7104         // after disconnect and that non-sequential htlc_ids result in a channel failure.
7105         let chanmon_cfgs = create_chanmon_cfgs(2);
7106         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7107         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7108         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7109         let logger = test_utils::TestLogger::new();
7110
7111         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7112         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7113         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7114         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7115         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7116         check_added_monitors!(nodes[0], 1);
7117         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7118         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7119
7120         //Disconnect and Reconnect
7121         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7122         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7123         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7124         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7125         assert_eq!(reestablish_1.len(), 1);
7126         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7127         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7128         assert_eq!(reestablish_2.len(), 1);
7129         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7130         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7131         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7132         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7133
7134         //Resend HTLC
7135         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7136         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
7137         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
7138         check_added_monitors!(nodes[1], 1);
7139         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7140
7141         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7142
7143         assert!(nodes[1].node.list_channels().is_empty());
7144         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7145         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
7146         check_added_monitors!(nodes[1], 1);
7147 }
7148
7149 #[test]
7150 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
7151         //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.
7152
7153         let chanmon_cfgs = create_chanmon_cfgs(2);
7154         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7155         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7156         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7157         let logger = test_utils::TestLogger::new();
7158         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7159         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7160         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7161         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7162         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7163
7164         check_added_monitors!(nodes[0], 1);
7165         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7166         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7167
7168         let update_msg = msgs::UpdateFulfillHTLC{
7169                 channel_id: chan.2,
7170                 htlc_id: 0,
7171                 payment_preimage: our_payment_preimage,
7172         };
7173
7174         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7175
7176         assert!(nodes[0].node.list_channels().is_empty());
7177         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7178         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()));
7179         check_added_monitors!(nodes[0], 1);
7180 }
7181
7182 #[test]
7183 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
7184         //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.
7185
7186         let chanmon_cfgs = create_chanmon_cfgs(2);
7187         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7188         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7189         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7190         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7191         let logger = test_utils::TestLogger::new();
7192
7193         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7194         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7195         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7196         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7197         check_added_monitors!(nodes[0], 1);
7198         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7199         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7200
7201         let update_msg = msgs::UpdateFailHTLC{
7202                 channel_id: chan.2,
7203                 htlc_id: 0,
7204                 reason: msgs::OnionErrorPacket { data: Vec::new()},
7205         };
7206
7207         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7208
7209         assert!(nodes[0].node.list_channels().is_empty());
7210         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7211         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()));
7212         check_added_monitors!(nodes[0], 1);
7213 }
7214
7215 #[test]
7216 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
7217         //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.
7218
7219         let chanmon_cfgs = create_chanmon_cfgs(2);
7220         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7221         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7222         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7223         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7224         let logger = test_utils::TestLogger::new();
7225
7226         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7227         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7228         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7229         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7230         check_added_monitors!(nodes[0], 1);
7231         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7232         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7233
7234         let update_msg = msgs::UpdateFailMalformedHTLC{
7235                 channel_id: chan.2,
7236                 htlc_id: 0,
7237                 sha256_of_onion: [1; 32],
7238                 failure_code: 0x8000,
7239         };
7240
7241         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7242
7243         assert!(nodes[0].node.list_channels().is_empty());
7244         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7245         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()));
7246         check_added_monitors!(nodes[0], 1);
7247 }
7248
7249 #[test]
7250 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
7251         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
7252
7253         let chanmon_cfgs = create_chanmon_cfgs(2);
7254         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7255         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7256         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7257         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7258
7259         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7260
7261         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
7262         check_added_monitors!(nodes[1], 1);
7263
7264         let events = nodes[1].node.get_and_clear_pending_msg_events();
7265         assert_eq!(events.len(), 1);
7266         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7267                 match events[0] {
7268                         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, .. } } => {
7269                                 assert!(update_add_htlcs.is_empty());
7270                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7271                                 assert!(update_fail_htlcs.is_empty());
7272                                 assert!(update_fail_malformed_htlcs.is_empty());
7273                                 assert!(update_fee.is_none());
7274                                 update_fulfill_htlcs[0].clone()
7275                         },
7276                         _ => panic!("Unexpected event"),
7277                 }
7278         };
7279
7280         update_fulfill_msg.htlc_id = 1;
7281
7282         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7283
7284         assert!(nodes[0].node.list_channels().is_empty());
7285         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7286         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7287         check_added_monitors!(nodes[0], 1);
7288 }
7289
7290 #[test]
7291 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7292         //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.
7293
7294         let chanmon_cfgs = create_chanmon_cfgs(2);
7295         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7296         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7297         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7298         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7299
7300         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7301
7302         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
7303         check_added_monitors!(nodes[1], 1);
7304
7305         let events = nodes[1].node.get_and_clear_pending_msg_events();
7306         assert_eq!(events.len(), 1);
7307         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7308                 match events[0] {
7309                         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, .. } } => {
7310                                 assert!(update_add_htlcs.is_empty());
7311                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7312                                 assert!(update_fail_htlcs.is_empty());
7313                                 assert!(update_fail_malformed_htlcs.is_empty());
7314                                 assert!(update_fee.is_none());
7315                                 update_fulfill_htlcs[0].clone()
7316                         },
7317                         _ => panic!("Unexpected event"),
7318                 }
7319         };
7320
7321         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7322
7323         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7324
7325         assert!(nodes[0].node.list_channels().is_empty());
7326         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7327         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7328         check_added_monitors!(nodes[0], 1);
7329 }
7330
7331 #[test]
7332 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7333         //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.
7334
7335         let chanmon_cfgs = create_chanmon_cfgs(2);
7336         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7337         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7338         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7339         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7340         let logger = test_utils::TestLogger::new();
7341
7342         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7343         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7344         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(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
7345         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7346         check_added_monitors!(nodes[0], 1);
7347
7348         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7349         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7350
7351         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7352         check_added_monitors!(nodes[1], 0);
7353         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7354
7355         let events = nodes[1].node.get_and_clear_pending_msg_events();
7356
7357         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7358                 match events[0] {
7359                         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, .. } } => {
7360                                 assert!(update_add_htlcs.is_empty());
7361                                 assert!(update_fulfill_htlcs.is_empty());
7362                                 assert!(update_fail_htlcs.is_empty());
7363                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7364                                 assert!(update_fee.is_none());
7365                                 update_fail_malformed_htlcs[0].clone()
7366                         },
7367                         _ => panic!("Unexpected event"),
7368                 }
7369         };
7370         update_msg.failure_code &= !0x8000;
7371         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7372
7373         assert!(nodes[0].node.list_channels().is_empty());
7374         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7375         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7376         check_added_monitors!(nodes[0], 1);
7377 }
7378
7379 #[test]
7380 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7381         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7382         //    * 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.
7383
7384         let chanmon_cfgs = create_chanmon_cfgs(3);
7385         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7386         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7387         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7388         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7389         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7390         let logger = test_utils::TestLogger::new();
7391
7392         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7393
7394         //First hop
7395         let mut payment_event = {
7396                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7397                 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(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
7398                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7399                 check_added_monitors!(nodes[0], 1);
7400                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7401                 assert_eq!(events.len(), 1);
7402                 SendEvent::from_event(events.remove(0))
7403         };
7404         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7405         check_added_monitors!(nodes[1], 0);
7406         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7407         expect_pending_htlcs_forwardable!(nodes[1]);
7408         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7409         assert_eq!(events_2.len(), 1);
7410         check_added_monitors!(nodes[1], 1);
7411         payment_event = SendEvent::from_event(events_2.remove(0));
7412         assert_eq!(payment_event.msgs.len(), 1);
7413
7414         //Second Hop
7415         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7416         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7417         check_added_monitors!(nodes[2], 0);
7418         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7419
7420         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7421         assert_eq!(events_3.len(), 1);
7422         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7423                 match events_3[0] {
7424                         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 } } => {
7425                                 assert!(update_add_htlcs.is_empty());
7426                                 assert!(update_fulfill_htlcs.is_empty());
7427                                 assert!(update_fail_htlcs.is_empty());
7428                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7429                                 assert!(update_fee.is_none());
7430                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7431                         },
7432                         _ => panic!("Unexpected event"),
7433                 }
7434         };
7435
7436         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7437
7438         check_added_monitors!(nodes[1], 0);
7439         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7440         expect_pending_htlcs_forwardable!(nodes[1]);
7441         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7442         assert_eq!(events_4.len(), 1);
7443
7444         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7445         match events_4[0] {
7446                 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, .. } } => {
7447                         assert!(update_add_htlcs.is_empty());
7448                         assert!(update_fulfill_htlcs.is_empty());
7449                         assert_eq!(update_fail_htlcs.len(), 1);
7450                         assert!(update_fail_malformed_htlcs.is_empty());
7451                         assert!(update_fee.is_none());
7452                 },
7453                 _ => panic!("Unexpected event"),
7454         };
7455
7456         check_added_monitors!(nodes[1], 1);
7457 }
7458
7459 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7460         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7461         // 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
7462         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7463
7464         let chanmon_cfgs = create_chanmon_cfgs(2);
7465         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7466         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7467         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7468         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7469
7470         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7471
7472         // We route 2 dust-HTLCs between A and B
7473         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7474         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7475         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7476
7477         // Cache one local commitment tx as previous
7478         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7479
7480         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7481         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
7482         check_added_monitors!(nodes[1], 0);
7483         expect_pending_htlcs_forwardable!(nodes[1]);
7484         check_added_monitors!(nodes[1], 1);
7485
7486         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7487         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7488         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7489         check_added_monitors!(nodes[0], 1);
7490
7491         // Cache one local commitment tx as lastest
7492         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7493
7494         let events = nodes[0].node.get_and_clear_pending_msg_events();
7495         match events[0] {
7496                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7497                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7498                 },
7499                 _ => panic!("Unexpected event"),
7500         }
7501         match events[1] {
7502                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7503                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7504                 },
7505                 _ => panic!("Unexpected event"),
7506         }
7507
7508         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7509         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7510         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7511
7512         if announce_latest {
7513                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
7514         } else {
7515                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
7516         }
7517
7518         check_closed_broadcast!(nodes[0], false);
7519         check_added_monitors!(nodes[0], 1);
7520
7521         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7522         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
7523         let events = nodes[0].node.get_and_clear_pending_events();
7524         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7525         assert_eq!(events.len(), 2);
7526         let mut first_failed = false;
7527         for event in events {
7528                 match event {
7529                         Event::PaymentFailed { payment_hash, .. } => {
7530                                 if payment_hash == payment_hash_1 {
7531                                         assert!(!first_failed);
7532                                         first_failed = true;
7533                                 } else {
7534                                         assert_eq!(payment_hash, payment_hash_2);
7535                                 }
7536                         }
7537                         _ => panic!("Unexpected event"),
7538                 }
7539         }
7540 }
7541
7542 #[test]
7543 fn test_failure_delay_dust_htlc_local_commitment() {
7544         do_test_failure_delay_dust_htlc_local_commitment(true);
7545         do_test_failure_delay_dust_htlc_local_commitment(false);
7546 }
7547
7548 #[test]
7549 fn test_no_failure_dust_htlc_local_commitment() {
7550         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
7551         // prone to error, we test here that a dummy transaction don't fail them.
7552
7553         let chanmon_cfgs = create_chanmon_cfgs(2);
7554         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7555         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7556         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7557         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7558
7559         // Rebalance a bit
7560         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7561
7562         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7563         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7564
7565         // We route 2 dust-HTLCs between A and B
7566         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7567         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
7568
7569         // Build a dummy invalid transaction trying to spend a commitment tx
7570         let input = TxIn {
7571                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
7572                 script_sig: Script::new(),
7573                 sequence: 0,
7574                 witness: Vec::new(),
7575         };
7576
7577         let outp = TxOut {
7578                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
7579                 value: 10000,
7580         };
7581
7582         let dummy_tx = Transaction {
7583                 version: 2,
7584                 lock_time: 0,
7585                 input: vec![input],
7586                 output: vec![outp]
7587         };
7588
7589         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7590         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
7591         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7592         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7593         // We broadcast a few more block to check everything is all right
7594         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
7595         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7596         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7597
7598         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
7599         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
7600 }
7601
7602 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7603         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7604         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7605         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7606         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7607         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7608         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7609
7610         let chanmon_cfgs = create_chanmon_cfgs(3);
7611         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7612         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7613         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7614         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7615
7616         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7617
7618         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7619         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7620
7621         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7622         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7623
7624         // We revoked bs_commitment_tx
7625         if revoked {
7626                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7627                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7628         }
7629
7630         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7631         let mut timeout_tx = Vec::new();
7632         if local {
7633                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7634                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
7635                 check_closed_broadcast!(nodes[0], false);
7636                 check_added_monitors!(nodes[0], 1);
7637                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7638                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7639                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7640                 expect_payment_failed!(nodes[0], dust_hash, true);
7641                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7642                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7643                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7644                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7645                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7646                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7647                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7648                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7649         } else {
7650                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7651                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
7652                 check_closed_broadcast!(nodes[0], false);
7653                 check_added_monitors!(nodes[0], 1);
7654                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7655                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7656                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7657                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7658                 if !revoked {
7659                         expect_payment_failed!(nodes[0], dust_hash, true);
7660                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7661                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7662                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7663                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7664                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7665                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7666                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7667                 } else {
7668                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7669                         // commitment tx
7670                         let events = nodes[0].node.get_and_clear_pending_events();
7671                         assert_eq!(events.len(), 2);
7672                         let first;
7673                         match events[0] {
7674                                 Event::PaymentFailed { payment_hash, .. } => {
7675                                         if payment_hash == dust_hash { first = true; }
7676                                         else { first = false; }
7677                                 },
7678                                 _ => panic!("Unexpected event"),
7679                         }
7680                         match events[1] {
7681                                 Event::PaymentFailed { payment_hash, .. } => {
7682                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7683                                         else { assert_eq!(payment_hash, dust_hash); }
7684                                 },
7685                                 _ => panic!("Unexpected event"),
7686                         }
7687                 }
7688         }
7689 }
7690
7691 #[test]
7692 fn test_sweep_outbound_htlc_failure_update() {
7693         do_test_sweep_outbound_htlc_failure_update(false, true);
7694         do_test_sweep_outbound_htlc_failure_update(false, false);
7695         do_test_sweep_outbound_htlc_failure_update(true, false);
7696 }
7697
7698 #[test]
7699 fn test_upfront_shutdown_script() {
7700         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7701         // enforce it at shutdown message
7702
7703         let mut config = UserConfig::default();
7704         config.channel_options.announced_channel = true;
7705         config.peer_channel_config_limits.force_announced_channel_preference = false;
7706         config.channel_options.commit_upfront_shutdown_pubkey = false;
7707         let user_cfgs = [None, Some(config), None];
7708         let chanmon_cfgs = create_chanmon_cfgs(3);
7709         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7710         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7711         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7712
7713         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7714         let flags = InitFeatures::known();
7715         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7716         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7717         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7718         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7719         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7720         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7721     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()));
7722         check_added_monitors!(nodes[2], 1);
7723
7724         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7725         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7726         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7727         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7728         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7729         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7730         let events = nodes[2].node.get_and_clear_pending_msg_events();
7731         assert_eq!(events.len(), 1);
7732         match events[0] {
7733                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7734                 _ => panic!("Unexpected event"),
7735         }
7736
7737         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7738         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7739         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7740         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7741         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7742         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7743         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
7744         let events = nodes[1].node.get_and_clear_pending_msg_events();
7745         assert_eq!(events.len(), 1);
7746         match events[0] {
7747                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7748                 _ => panic!("Unexpected event"),
7749         }
7750
7751         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7752         // channel smoothly, opt-out is from channel initiator here
7753         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7754         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7755         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7756         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7757         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7758         let events = nodes[0].node.get_and_clear_pending_msg_events();
7759         assert_eq!(events.len(), 1);
7760         match events[0] {
7761                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7762                 _ => panic!("Unexpected event"),
7763         }
7764
7765         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7766         //// channel smoothly
7767         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7768         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7769         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7770         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7771         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7772         let events = nodes[0].node.get_and_clear_pending_msg_events();
7773         assert_eq!(events.len(), 2);
7774         match events[0] {
7775                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7776                 _ => panic!("Unexpected event"),
7777         }
7778         match events[1] {
7779                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7780                 _ => panic!("Unexpected event"),
7781         }
7782 }
7783
7784 #[test]
7785 fn test_user_configurable_csv_delay() {
7786         // We test our channel constructors yield errors when we pass them absurd csv delay
7787
7788         let mut low_our_to_self_config = UserConfig::default();
7789         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7790         let mut high_their_to_self_config = UserConfig::default();
7791         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7792         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7793         let chanmon_cfgs = create_chanmon_cfgs(2);
7794         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7795         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7796         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7797
7798         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7799         let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet));
7800         if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7801                 match error {
7802                         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())); },
7803                         _ => panic!("Unexpected event"),
7804                 }
7805         } else { assert!(false) }
7806
7807         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7808         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7809         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7810         open_channel.to_self_delay = 200;
7811         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7812                 match error {
7813                         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()));  },
7814                         _ => panic!("Unexpected event"),
7815                 }
7816         } else { assert!(false); }
7817
7818         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7819         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7820         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()));
7821         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7822         accept_channel.to_self_delay = 200;
7823         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7824         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7825                 match action {
7826                         &ErrorAction::SendErrorMessage { ref msg } => {
7827                                 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()));
7828                         },
7829                         _ => { assert!(false); }
7830                 }
7831         } else { assert!(false); }
7832
7833         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7834         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7835         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7836         open_channel.to_self_delay = 200;
7837         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7838                 match error {
7839                         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())); },
7840                         _ => panic!("Unexpected event"),
7841                 }
7842         } else { assert!(false); }
7843 }
7844
7845 #[test]
7846 fn test_data_loss_protect() {
7847         // We want to be sure that :
7848         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7849         // * we close channel in case of detecting other being fallen behind
7850         // * we are able to claim our own outputs thanks to to_remote being static
7851         let keys_manager;
7852         let logger;
7853         let fee_estimator;
7854         let tx_broadcaster;
7855         let chain_monitor;
7856         let monitor;
7857         let node_state_0;
7858         let chanmon_cfgs = create_chanmon_cfgs(2);
7859         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7860         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7861         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7862
7863         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7864
7865         // Cache node A state before any channel update
7866         let previous_node_state = nodes[0].node.encode();
7867         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
7868         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
7869
7870         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7871         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7872
7873         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7874         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7875
7876         // Restore node A from previous state
7877         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7878         let mut chan_monitor = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0)).unwrap().1;
7879         chain_monitor = ChainWatchInterfaceUtil::new(Network::Testnet);
7880         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7881         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7882         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
7883         monitor = test_utils::TestChannelMonitor::new(&chain_monitor, &tx_broadcaster, &logger, &fee_estimator);
7884         node_state_0 = {
7885                 let mut channel_monitors = HashMap::new();
7886                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
7887                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7888                         keys_manager: &keys_manager,
7889                         fee_estimator: &fee_estimator,
7890                         monitor: &monitor,
7891                         logger: &logger,
7892                         tx_broadcaster: &tx_broadcaster,
7893                         default_config: UserConfig::default(),
7894                         channel_monitors,
7895                 }).unwrap().1
7896         };
7897         nodes[0].node = &node_state_0;
7898         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
7899         nodes[0].chan_monitor = &monitor;
7900         nodes[0].chain_monitor = &chain_monitor;
7901
7902         nodes[0].block_notifier = BlockNotifier::new(&nodes[0].chain_monitor);
7903         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
7904         nodes[0].block_notifier.register_listener(nodes[0].node);
7905
7906         check_added_monitors!(nodes[0], 1);
7907
7908         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7909         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7910
7911         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7912
7913         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7914         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7915         check_added_monitors!(nodes[0], 1);
7916
7917         {
7918                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7919                 assert_eq!(node_txn.len(), 0);
7920         }
7921
7922         let mut reestablish_1 = Vec::with_capacity(1);
7923         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7924                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7925                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7926                         reestablish_1.push(msg.clone());
7927                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7928                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7929                         match action {
7930                                 &ErrorAction::SendErrorMessage { ref msg } => {
7931                                         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");
7932                                 },
7933                                 _ => panic!("Unexpected event!"),
7934                         }
7935                 } else {
7936                         panic!("Unexpected event")
7937                 }
7938         }
7939
7940         // Check we close channel detecting A is fallen-behind
7941         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7942         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7943         check_added_monitors!(nodes[1], 1);
7944
7945
7946         // Check A is able to claim to_remote output
7947         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7948         assert_eq!(node_txn.len(), 1);
7949         check_spends!(node_txn[0], chan.3);
7950         assert_eq!(node_txn[0].output.len(), 2);
7951         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
7952         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
7953         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
7954         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
7955         assert_eq!(spend_txn.len(), 1);
7956         check_spends!(spend_txn[0], node_txn[0]);
7957 }
7958
7959 #[test]
7960 fn test_check_htlc_underpaying() {
7961         // Send payment through A -> B but A is maliciously
7962         // sending a probe payment (i.e less than expected value0
7963         // to B, B should refuse payment.
7964
7965         let chanmon_cfgs = create_chanmon_cfgs(2);
7966         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7967         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7968         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7969
7970         // Create some initial channels
7971         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7972
7973         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7974
7975         // Node 3 is expecting payment of 100_000 but receive 10_000,
7976         // fail htlc like we didn't know the preimage.
7977         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7978         nodes[1].node.process_pending_htlc_forwards();
7979
7980         let events = nodes[1].node.get_and_clear_pending_msg_events();
7981         assert_eq!(events.len(), 1);
7982         let (update_fail_htlc, commitment_signed) = match events[0] {
7983                 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 } } => {
7984                         assert!(update_add_htlcs.is_empty());
7985                         assert!(update_fulfill_htlcs.is_empty());
7986                         assert_eq!(update_fail_htlcs.len(), 1);
7987                         assert!(update_fail_malformed_htlcs.is_empty());
7988                         assert!(update_fee.is_none());
7989                         (update_fail_htlcs[0].clone(), commitment_signed)
7990                 },
7991                 _ => panic!("Unexpected event"),
7992         };
7993         check_added_monitors!(nodes[1], 1);
7994
7995         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7996         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7997
7998         // 10_000 msat as u64, followed by a height of 99 as u32
7999         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
8000         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(99));
8001         expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
8002         nodes[1].node.get_and_clear_pending_events();
8003 }
8004
8005 #[test]
8006 fn test_announce_disable_channels() {
8007         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
8008         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
8009
8010         let chanmon_cfgs = create_chanmon_cfgs(2);
8011         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8012         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8013         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8014
8015         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8016         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8017         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8018
8019         // Disconnect peers
8020         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
8021         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8022
8023         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
8024         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
8025         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
8026         assert_eq!(msg_events.len(), 3);
8027         for e in msg_events {
8028                 match e {
8029                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
8030                                 let short_id = msg.contents.short_channel_id;
8031                                 // Check generated channel_update match list in PendingChannelUpdate
8032                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
8033                                         panic!("Generated ChannelUpdate for wrong chan!");
8034                                 }
8035                         },
8036                         _ => panic!("Unexpected event"),
8037                 }
8038         }
8039         // Reconnect peers
8040         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8041         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
8042         assert_eq!(reestablish_1.len(), 3);
8043         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
8044         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
8045         assert_eq!(reestablish_2.len(), 3);
8046
8047         // Reestablish chan_1
8048         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
8049         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8050         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
8051         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8052         // Reestablish chan_2
8053         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
8054         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8055         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
8056         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8057         // Reestablish chan_3
8058         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
8059         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8060         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
8061         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8062
8063         nodes[0].node.timer_chan_freshness_every_min();
8064         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
8065 }
8066
8067 #[test]
8068 fn test_bump_penalty_txn_on_revoked_commitment() {
8069         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
8070         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
8071
8072         let chanmon_cfgs = create_chanmon_cfgs(2);
8073         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8074         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8075         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8076
8077         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8078         let logger = test_utils::TestLogger::new();
8079
8080
8081         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8082         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8083         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(), None, &Vec::new(), 3000000, 30, &logger).unwrap();
8084         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
8085
8086         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
8087         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8088         assert_eq!(revoked_txn[0].output.len(), 4);
8089         assert_eq!(revoked_txn[0].input.len(), 1);
8090         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
8091         let revoked_txid = revoked_txn[0].txid();
8092
8093         let mut penalty_sum = 0;
8094         for outp in revoked_txn[0].output.iter() {
8095                 if outp.script_pubkey.is_v0_p2wsh() {
8096                         penalty_sum += outp.value;
8097                 }
8098         }
8099
8100         // Connect blocks to change height_timer range to see if we use right soonest_timelock
8101         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
8102
8103         // Actually revoke tx by claiming a HTLC
8104         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
8105         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8106         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
8107         check_added_monitors!(nodes[1], 1);
8108
8109         // One or more justice tx should have been broadcast, check it
8110         let penalty_1;
8111         let feerate_1;
8112         {
8113                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8114                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
8115                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8116                 assert_eq!(node_txn[0].output.len(), 1);
8117                 check_spends!(node_txn[0], revoked_txn[0]);
8118                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
8119                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
8120                 penalty_1 = node_txn[0].txid();
8121                 node_txn.clear();
8122         };
8123
8124         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
8125         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
8126         let mut penalty_2 = penalty_1;
8127         let mut feerate_2 = 0;
8128         {
8129                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8130                 assert_eq!(node_txn.len(), 1);
8131                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8132                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8133                         assert_eq!(node_txn[0].output.len(), 1);
8134                         check_spends!(node_txn[0], revoked_txn[0]);
8135                         penalty_2 = node_txn[0].txid();
8136                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8137                         assert_ne!(penalty_2, penalty_1);
8138                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
8139                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8140                         // Verify 25% bump heuristic
8141                         assert!(feerate_2 * 100 >= feerate_1 * 125);
8142                         node_txn.clear();
8143                 }
8144         }
8145         assert_ne!(feerate_2, 0);
8146
8147         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
8148         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
8149         let penalty_3;
8150         let mut feerate_3 = 0;
8151         {
8152                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8153                 assert_eq!(node_txn.len(), 1);
8154                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8155                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8156                         assert_eq!(node_txn[0].output.len(), 1);
8157                         check_spends!(node_txn[0], revoked_txn[0]);
8158                         penalty_3 = node_txn[0].txid();
8159                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8160                         assert_ne!(penalty_3, penalty_2);
8161                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
8162                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8163                         // Verify 25% bump heuristic
8164                         assert!(feerate_3 * 100 >= feerate_2 * 125);
8165                         node_txn.clear();
8166                 }
8167         }
8168         assert_ne!(feerate_3, 0);
8169
8170         nodes[1].node.get_and_clear_pending_events();
8171         nodes[1].node.get_and_clear_pending_msg_events();
8172 }
8173
8174 #[test]
8175 fn test_bump_penalty_txn_on_revoked_htlcs() {
8176         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8177         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8178
8179         let chanmon_cfgs = create_chanmon_cfgs(2);
8180         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8181         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8182         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8183
8184         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8185         // Lock HTLC in both directions
8186         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
8187         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8188
8189         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8190         assert_eq!(revoked_local_txn[0].input.len(), 1);
8191         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8192
8193         // Revoke local commitment tx
8194         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
8195
8196         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8197         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8198         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
8199         check_closed_broadcast!(nodes[1], false);
8200         check_added_monitors!(nodes[1], 1);
8201
8202         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8203         assert_eq!(revoked_htlc_txn.len(), 4);
8204         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8205                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8206                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8207                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
8208                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8209                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
8210         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8211                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
8212                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
8213                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8214                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8215                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8216         }
8217
8218         // Broadcast set of revoked txn on A
8219         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
8220         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8221
8222         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8223         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
8224         let first;
8225         let feerate_1;
8226         let penalty_txn;
8227         {
8228                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8229                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8230                 // Verify claim tx are spending revoked HTLC txn
8231                 assert_eq!(node_txn[4].input.len(), 2);
8232                 assert_eq!(node_txn[4].output.len(), 1);
8233                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8234                 first = node_txn[4].txid();
8235                 // Store both feerates for later comparison
8236                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
8237                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8238                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8239                 node_txn.clear();
8240         }
8241
8242         // Connect three more block to see if bumped penalty are issued for HTLC txn
8243         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8244         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
8245         {
8246                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8247                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8248
8249                 check_spends!(node_txn[0], revoked_local_txn[0]);
8250                 check_spends!(node_txn[1], revoked_local_txn[0]);
8251
8252                 node_txn.clear();
8253         };
8254
8255         // Few more blocks to confirm penalty txn
8256         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
8257         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8258         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
8259         let node_txn = {
8260                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8261                 assert_eq!(node_txn.len(), 1);
8262
8263                 assert_eq!(node_txn[0].input.len(), 2);
8264                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8265                 // Verify bumped tx is different and 25% bump heuristic
8266                 assert_ne!(first, node_txn[0].txid());
8267                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
8268                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8269                 assert!(feerate_2 * 100 > feerate_1 * 125);
8270                 let txn = vec![node_txn[0].clone()];
8271                 node_txn.clear();
8272                 txn
8273         };
8274         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8275         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8276         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
8277         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
8278         {
8279                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8280                 // We verify than no new transaction has been broadcast because previously
8281                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8282                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8283                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8284                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8285                 // up bumped justice generation.
8286                 assert_eq!(node_txn.len(), 0);
8287                 node_txn.clear();
8288         }
8289         check_closed_broadcast!(nodes[0], false);
8290         check_added_monitors!(nodes[0], 1);
8291 }
8292
8293 #[test]
8294 fn test_bump_penalty_txn_on_remote_commitment() {
8295         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8296         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8297
8298         // Create 2 HTLCs
8299         // Provide preimage for one
8300         // Check aggregation
8301
8302         let chanmon_cfgs = create_chanmon_cfgs(2);
8303         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8304         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8305         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8306
8307         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8308         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8309         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8310
8311         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8312         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8313         assert_eq!(remote_txn[0].output.len(), 4);
8314         assert_eq!(remote_txn[0].input.len(), 1);
8315         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8316
8317         // Claim a HTLC without revocation (provide B monitor with preimage)
8318         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
8319         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8320         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
8321         check_added_monitors!(nodes[1], 2);
8322
8323         // One or more claim tx should have been broadcast, check it
8324         let timeout;
8325         let preimage;
8326         let feerate_timeout;
8327         let feerate_preimage;
8328         {
8329                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8330                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
8331                 assert_eq!(node_txn[0].input.len(), 1);
8332                 assert_eq!(node_txn[1].input.len(), 1);
8333                 check_spends!(node_txn[0], remote_txn[0]);
8334                 check_spends!(node_txn[1], remote_txn[0]);
8335                 check_spends!(node_txn[2], chan.3);
8336                 check_spends!(node_txn[3], node_txn[2]);
8337                 check_spends!(node_txn[4], node_txn[2]);
8338                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8339                         timeout = node_txn[0].txid();
8340                         let index = node_txn[0].input[0].previous_output.vout;
8341                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8342                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
8343
8344                         preimage = node_txn[1].txid();
8345                         let index = node_txn[1].input[0].previous_output.vout;
8346                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8347                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
8348                 } else {
8349                         timeout = node_txn[1].txid();
8350                         let index = node_txn[1].input[0].previous_output.vout;
8351                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8352                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
8353
8354                         preimage = node_txn[0].txid();
8355                         let index = node_txn[0].input[0].previous_output.vout;
8356                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8357                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8358                 }
8359                 node_txn.clear();
8360         };
8361         assert_ne!(feerate_timeout, 0);
8362         assert_ne!(feerate_preimage, 0);
8363
8364         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8365         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
8366         {
8367                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8368                 assert_eq!(node_txn.len(), 2);
8369                 assert_eq!(node_txn[0].input.len(), 1);
8370                 assert_eq!(node_txn[1].input.len(), 1);
8371                 check_spends!(node_txn[0], remote_txn[0]);
8372                 check_spends!(node_txn[1], remote_txn[0]);
8373                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8374                         let index = node_txn[0].input[0].previous_output.vout;
8375                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8376                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8377                         assert!(new_feerate * 100 > feerate_timeout * 125);
8378                         assert_ne!(timeout, node_txn[0].txid());
8379
8380                         let index = node_txn[1].input[0].previous_output.vout;
8381                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8382                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8383                         assert!(new_feerate * 100 > feerate_preimage * 125);
8384                         assert_ne!(preimage, node_txn[1].txid());
8385                 } else {
8386                         let index = node_txn[1].input[0].previous_output.vout;
8387                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8388                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8389                         assert!(new_feerate * 100 > feerate_timeout * 125);
8390                         assert_ne!(timeout, node_txn[1].txid());
8391
8392                         let index = node_txn[0].input[0].previous_output.vout;
8393                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8394                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8395                         assert!(new_feerate * 100 > feerate_preimage * 125);
8396                         assert_ne!(preimage, node_txn[0].txid());
8397                 }
8398                 node_txn.clear();
8399         }
8400
8401         nodes[1].node.get_and_clear_pending_events();
8402         nodes[1].node.get_and_clear_pending_msg_events();
8403 }
8404
8405 #[test]
8406 fn test_set_outpoints_partial_claiming() {
8407         // - remote party claim tx, new bump tx
8408         // - disconnect remote claiming tx, new bump
8409         // - disconnect tx, see no tx anymore
8410         let chanmon_cfgs = create_chanmon_cfgs(2);
8411         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8412         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8413         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8414
8415         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8416         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8417         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8418
8419         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
8420         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
8421         assert_eq!(remote_txn.len(), 3);
8422         assert_eq!(remote_txn[0].output.len(), 4);
8423         assert_eq!(remote_txn[0].input.len(), 1);
8424         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8425         check_spends!(remote_txn[1], remote_txn[0]);
8426         check_spends!(remote_txn[2], remote_txn[0]);
8427
8428         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
8429         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
8430         // Provide node A with both preimage
8431         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
8432         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
8433         check_added_monitors!(nodes[0], 2);
8434         nodes[0].node.get_and_clear_pending_events();
8435         nodes[0].node.get_and_clear_pending_msg_events();
8436
8437         // Connect blocks on node A commitment transaction
8438         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8439         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
8440         check_closed_broadcast!(nodes[0], false);
8441         check_added_monitors!(nodes[0], 1);
8442         // Verify node A broadcast tx claiming both HTLCs
8443         {
8444                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8445                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
8446                 assert_eq!(node_txn.len(), 4);
8447                 check_spends!(node_txn[0], remote_txn[0]);
8448                 check_spends!(node_txn[1], chan.3);
8449                 check_spends!(node_txn[2], node_txn[1]);
8450                 check_spends!(node_txn[3], node_txn[1]);
8451                 assert_eq!(node_txn[0].input.len(), 2);
8452                 node_txn.clear();
8453         }
8454
8455         // Connect blocks on node B
8456         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
8457         check_closed_broadcast!(nodes[1], false);
8458         check_added_monitors!(nodes[1], 1);
8459         // Verify node B broadcast 2 HTLC-timeout txn
8460         let partial_claim_tx = {
8461                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8462                 assert_eq!(node_txn.len(), 3);
8463                 check_spends!(node_txn[1], node_txn[0]);
8464                 check_spends!(node_txn[2], node_txn[0]);
8465                 assert_eq!(node_txn[1].input.len(), 1);
8466                 assert_eq!(node_txn[2].input.len(), 1);
8467                 node_txn[1].clone()
8468         };
8469
8470         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
8471         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8472         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
8473         {
8474                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8475                 assert_eq!(node_txn.len(), 1);
8476                 check_spends!(node_txn[0], remote_txn[0]);
8477                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
8478                 node_txn.clear();
8479         }
8480         nodes[0].node.get_and_clear_pending_msg_events();
8481
8482         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
8483         nodes[0].block_notifier.block_disconnected(&header, 102);
8484         {
8485                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8486                 assert_eq!(node_txn.len(), 1);
8487                 check_spends!(node_txn[0], remote_txn[0]);
8488                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
8489                 node_txn.clear();
8490         }
8491
8492         //// Disconnect one more block and then reconnect multiple no transaction should be generated
8493         nodes[0].block_notifier.block_disconnected(&header, 101);
8494         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
8495         {
8496                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8497                 assert_eq!(node_txn.len(), 0);
8498                 node_txn.clear();
8499         }
8500 }
8501
8502 #[test]
8503 fn test_counterparty_raa_skip_no_crash() {
8504         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8505         // commitment transaction, we would have happily carried on and provided them the next
8506         // commitment transaction based on one RAA forward. This would probably eventually have led to
8507         // channel closure, but it would not have resulted in funds loss. Still, our
8508         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
8509         // check simply that the channel is closed in response to such an RAA, but don't check whether
8510         // we decide to punish our counterparty for revoking their funds (as we don't currently
8511         // implement that).
8512         let chanmon_cfgs = create_chanmon_cfgs(2);
8513         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8514         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8515         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8516         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8517
8518         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8519         let local_keys = &guard.by_id.get_mut(&channel_id).unwrap().local_keys;
8520         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8521         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8522                 &SecretKey::from_slice(&local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8523         let per_commitment_secret = local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8524
8525         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8526                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8527         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8528         check_added_monitors!(nodes[1], 1);
8529 }
8530
8531 #[test]
8532 fn test_bump_txn_sanitize_tracking_maps() {
8533         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8534         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8535
8536         let chanmon_cfgs = create_chanmon_cfgs(2);
8537         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8538         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8539         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8540
8541         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8542         // Lock HTLC in both directions
8543         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8544         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8545
8546         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8547         assert_eq!(revoked_local_txn[0].input.len(), 1);
8548         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8549
8550         // Revoke local commitment tx
8551         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8552
8553         // Broadcast set of revoked txn on A
8554         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
8555         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8556
8557         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8558         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
8559         check_closed_broadcast!(nodes[0], false);
8560         check_added_monitors!(nodes[0], 1);
8561         let penalty_txn = {
8562                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8563                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8564                 check_spends!(node_txn[0], revoked_local_txn[0]);
8565                 check_spends!(node_txn[1], revoked_local_txn[0]);
8566                 check_spends!(node_txn[2], revoked_local_txn[0]);
8567                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8568                 node_txn.clear();
8569                 penalty_txn
8570         };
8571         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8572         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
8573         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
8574         {
8575                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8576                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8577                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
8578                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
8579                 }
8580         }
8581 }
8582
8583 #[test]
8584 fn test_override_channel_config() {
8585         let chanmon_cfgs = create_chanmon_cfgs(2);
8586         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8587         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8588         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8589
8590         // Node0 initiates a channel to node1 using the override config.
8591         let mut override_config = UserConfig::default();
8592         override_config.own_channel_config.our_to_self_delay = 200;
8593
8594         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8595
8596         // Assert the channel created by node0 is using the override config.
8597         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8598         assert_eq!(res.channel_flags, 0);
8599         assert_eq!(res.to_self_delay, 200);
8600 }
8601
8602 #[test]
8603 fn test_override_0msat_htlc_minimum() {
8604         let mut zero_config = UserConfig::default();
8605         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8606         let chanmon_cfgs = create_chanmon_cfgs(2);
8607         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8608         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8609         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8610
8611         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8612         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8613         assert_eq!(res.htlc_minimum_msat, 1);
8614
8615         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8616         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8617         assert_eq!(res.htlc_minimum_msat, 1);
8618 }
8619
8620 #[test]
8621 fn test_simple_payment_secret() {
8622         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8623         // features, however.
8624         let chanmon_cfgs = create_chanmon_cfgs(3);
8625         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8626         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8627         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8628
8629         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8630         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8631         let logger = test_utils::TestLogger::new();
8632
8633         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8634         let payment_secret = PaymentSecret([0xdb; 32]);
8635         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8636         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8637         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8638         // Claiming with all the correct values but the wrong secret should result in nothing...
8639         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8640         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8641         // ...but with the right secret we should be able to claim all the way back
8642         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8643 }
8644
8645 #[test]
8646 fn test_simple_mpp() {
8647         // Simple test of sending a multi-path payment.
8648         let chanmon_cfgs = create_chanmon_cfgs(4);
8649         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8650         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8651         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8652
8653         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8654         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8655         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8656         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8657         let logger = test_utils::TestLogger::new();
8658
8659         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8660         let payment_secret = PaymentSecret([0xdb; 32]);
8661         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8662         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(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
8663         let path = route.paths[0].clone();
8664         route.paths.push(path);
8665         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8666         route.paths[0][0].short_channel_id = chan_1_id;
8667         route.paths[0][1].short_channel_id = chan_3_id;
8668         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8669         route.paths[1][0].short_channel_id = chan_2_id;
8670         route.paths[1][1].short_channel_id = chan_4_id;
8671         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8672         // Claiming with all the correct values but the wrong secret should result in nothing...
8673         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8674         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8675         // ...but with the right secret we should be able to claim all the way back
8676         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8677 }
8678
8679 #[test]
8680 fn test_update_err_monitor_lockdown() {
8681         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8682         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8683         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8684         //
8685         // This scenario may happen in a watchtower setup, where watchtower process a block height
8686         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8687         // commitment at same time.
8688
8689         let chanmon_cfgs = create_chanmon_cfgs(2);
8690         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8691         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8692         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8693
8694         // Create some initial channel
8695         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8696         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8697
8698         // Rebalance the network to generate htlc in the two directions
8699         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8700
8701         // Route a HTLC from node 0 to node 1 (but don't settle)
8702         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8703
8704         // Copy SimpleManyChannelMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8705         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8706         let chain_monitor = chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet);
8707         let watchtower = {
8708                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8709                 let monitor = monitors.get(&outpoint).unwrap();
8710                 let mut w = test_utils::TestVecWriter(Vec::new());
8711                 monitor.write_for_disk(&mut w).unwrap();
8712                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8713                                 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
8714                 assert!(new_monitor == *monitor);
8715                 let watchtower = test_utils::TestChannelMonitor::new(&chain_monitor, &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator);
8716                 assert!(watchtower.add_monitor(outpoint, new_monitor).is_ok());
8717                 watchtower
8718         };
8719         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8720         watchtower.simple_monitor.block_connected(&header, 200, &vec![], &vec![]);
8721
8722         // Try to update ChannelMonitor
8723         assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8724         check_added_monitors!(nodes[1], 1);
8725         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8726         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8727         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8728         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8729                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8730                         if let Err(_) =  watchtower.simple_monitor.update_monitor(outpoint, update.clone()) {} else { assert!(false); }
8731                         if let Ok(_) = nodes[0].chan_monitor.update_monitor(outpoint, update) {} else { assert!(false); }
8732                 } else { assert!(false); }
8733         } else { assert!(false); };
8734         // Our local monitor is in-sync and hasn't processed yet timeout
8735         check_added_monitors!(nodes[0], 1);
8736         let events = nodes[0].node.get_and_clear_pending_events();
8737         assert_eq!(events.len(), 1);
8738 }