_ 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::Watch;
  15 use chain::transaction::OutPoint;
  16 use chain::keysinterface::{ChannelKeys, KeysInterface, SpendableOutputDescriptor};
  17 use chain::chaininterface::{ChainListener, BlockNotifier};
  18 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  19 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  20 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, 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};
  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, ReadableArgs, Readable};
  33 use util::config::UserConfig;
  34
  35 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  36 use bitcoin::hashes::HashEngine;
  37 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
  38 use bitcoin::util::bip143;
  39 use bitcoin::util::address::Address;
  40 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  41 use bitcoin::blockdata::block::{Block, BlockHeader};
  42 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
  43 use bitcoin::blockdata::script::{Builder, Script};
  44 use bitcoin::blockdata::opcodes;
  45 use bitcoin::blockdata::constants::genesis_block;
  46 use bitcoin::network::constants::Network;
  47
  48 use bitcoin::hashes::sha256::Hash as Sha256;
  49 use bitcoin::hashes::Hash;
  50
  51 use bitcoin::secp256k1::{Secp256k1, Message};
  52 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  53
  54 use regex;
  55
  56 use std::collections::{BTreeSet, HashMap, HashSet};
  57 use std::default::Default;
  58 use std::sync::{Arc, Mutex};
  59 use std::sync::atomic::Ordering;
  60 use std::mem;
  61
  62 use ln::functional_test_utils::*;
  63 use ln::chan_utils::PreCalculatedTxCreationKeys;
  64
  65 #[test]
  66 fn test_insane_channel_opens() {
  67         // Stand up a network of 2 nodes
  68         let chanmon_cfgs = create_chanmon_cfgs(2);
  69         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  70         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  71         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  72
  73         // Instantiate channel parameters where we push the maximum msats given our
  74         // funding satoshis
  75         let channel_value_sat = 31337; // same as funding satoshis
  76         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_holder_selected_channel_reserve_satoshis(channel_value_sat);
  77         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  78
  79         // Have node0 initiate a channel to node1 with aforementioned parameters
  80         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  81
  82         // Extract the channel open message from node0 to node1
  83         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  84
  85         // Test helper that asserts we get the correct error string given a mutator
  86         // that supposedly makes the channel open message insane
  87         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  88                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  89                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  90                 assert_eq!(msg_events.len(), 1);
  91                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  92                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  93                         match action {
  94                                 &ErrorAction::SendErrorMessage { .. } => {
  95                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  96                                 },
  97                                 _ => panic!("unexpected event!"),
  98                         }
  99                 } else { assert!(false); }
 100         };
 101
 102         use ln::channel::MAX_FUNDING_SATOSHIS;
 103         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
 104
 105         // Test all mutations that would make the channel open message insane
 106         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 });
 107
 108         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 109
 110         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 });
 111
 112         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 113
 114         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 });
 115
 116         insane_open_helper(r"Minimum htlc value \(\d+\) was larger than full channel value \(\d+\)", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
 117
 118         insane_open_helper("They wanted our payments to be delayed by a needlessly long period", |mut msg| { msg.to_self_delay = MAX_LOCAL_BREAKDOWN_TIMEOUT + 1; msg });
 119
 120         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 121
 122         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 123 }
 124
 125 #[test]
 126 fn test_async_inbound_update_fee() {
 127         let chanmon_cfgs = create_chanmon_cfgs(2);
 128         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 129         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 130         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 131         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 132         let logger = test_utils::TestLogger::new();
 133         let channel_id = chan.2;
 134
 135         // balancing
 136         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 137
 138         // A                                        B
 139         // update_fee                            ->
 140         // send (1) commitment_signed            -.
 141         //                                       <- update_add_htlc/commitment_signed
 142         // send (2) RAA (awaiting remote revoke) -.
 143         // (1) commitment_signed is delivered    ->
 144         //                                       .- send (3) RAA (awaiting remote revoke)
 145         // (2) RAA is delivered                  ->
 146         //                                       .- send (4) commitment_signed
 147         //                                       <- (3) RAA is delivered
 148         // send (5) commitment_signed            -.
 149         //                                       <- (4) commitment_signed is delivered
 150         // send (6) RAA                          -.
 151         // (5) commitment_signed is delivered    ->
 152         //                                       <- RAA
 153         // (6) RAA is delivered                  ->
 154
 155         // First nodes[0] generates an update_fee
 156         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 157         check_added_monitors!(nodes[0], 1);
 158
 159         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 160         assert_eq!(events_0.len(), 1);
 161         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 162                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 163                         (update_fee.as_ref(), commitment_signed)
 164                 },
 165                 _ => panic!("Unexpected event"),
 166         };
 167
 168         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 169
 170         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 171         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 172         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 173         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();
 174         check_added_monitors!(nodes[1], 1);
 175
 176         let payment_event = {
 177                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 178                 assert_eq!(events_1.len(), 1);
 179                 SendEvent::from_event(events_1.remove(0))
 180         };
 181         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 182         assert_eq!(payment_event.msgs.len(), 1);
 183
 184         // ...now when the messages get delivered everyone should be happy
 185         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 186         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 187         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 188         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 189         check_added_monitors!(nodes[0], 1);
 190
 191         // deliver(1), generate (3):
 192         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 193         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 194         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 195         check_added_monitors!(nodes[1], 1);
 196
 197         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 198         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 199         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 200         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 201         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 202         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 203         assert!(bs_update.update_fee.is_none()); // (4)
 204         check_added_monitors!(nodes[1], 1);
 205
 206         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 207         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 208         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 209         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 210         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 211         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 212         assert!(as_update.update_fee.is_none()); // (5)
 213         check_added_monitors!(nodes[0], 1);
 214
 215         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 216         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 217         // only (6) so get_event_msg's assert(len == 1) passes
 218         check_added_monitors!(nodes[0], 1);
 219
 220         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 221         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 222         check_added_monitors!(nodes[1], 1);
 223
 224         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 225         check_added_monitors!(nodes[0], 1);
 226
 227         let events_2 = nodes[0].node.get_and_clear_pending_events();
 228         assert_eq!(events_2.len(), 1);
 229         match events_2[0] {
 230                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 231                 _ => panic!("Unexpected event"),
 232         }
 233
 234         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 235         check_added_monitors!(nodes[1], 1);
 236 }
 237
 238 #[test]
 239 fn test_update_fee_unordered_raa() {
 240         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 241         // crash in an earlier version of the update_fee patch)
 242         let chanmon_cfgs = create_chanmon_cfgs(2);
 243         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 244         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 245         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 246         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 247         let channel_id = chan.2;
 248         let logger = test_utils::TestLogger::new();
 249
 250         // balancing
 251         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 252
 253         // First nodes[0] generates an update_fee
 254         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 255         check_added_monitors!(nodes[0], 1);
 256
 257         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 258         assert_eq!(events_0.len(), 1);
 259         let update_msg = match events_0[0] { // (1)
 260                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 261                         update_fee.as_ref()
 262                 },
 263                 _ => panic!("Unexpected event"),
 264         };
 265
 266         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 267
 268         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 269         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 270         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 271         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();
 272         check_added_monitors!(nodes[1], 1);
 273
 274         let payment_event = {
 275                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 276                 assert_eq!(events_1.len(), 1);
 277                 SendEvent::from_event(events_1.remove(0))
 278         };
 279         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 280         assert_eq!(payment_event.msgs.len(), 1);
 281
 282         // ...now when the messages get delivered everyone should be happy
 283         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 284         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 285         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 286         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 287         check_added_monitors!(nodes[0], 1);
 288
 289         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 290         check_added_monitors!(nodes[1], 1);
 291
 292         // We can't continue, sadly, because our (1) now has a bogus signature
 293 }
 294
 295 #[test]
 296 fn test_multi_flight_update_fee() {
 297         let chanmon_cfgs = create_chanmon_cfgs(2);
 298         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 299         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 300         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 301         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 302         let channel_id = chan.2;
 303
 304         // A                                        B
 305         // update_fee/commitment_signed          ->
 306         //                                       .- send (1) RAA and (2) commitment_signed
 307         // update_fee (never committed)          ->
 308         // (3) update_fee                        ->
 309         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 310         // don't track which updates correspond to which revoke_and_ack responses so we're in
 311         // AwaitingRAA mode and will not generate the update_fee yet.
 312         //                                       <- (1) RAA delivered
 313         // (3) is generated and send (4) CS      -.
 314         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 315         // know the per_commitment_point to use for it.
 316         //                                       <- (2) commitment_signed delivered
 317         // revoke_and_ack                        ->
 318         //                                          B should send no response here
 319         // (4) commitment_signed delivered       ->
 320         //                                       <- RAA/commitment_signed delivered
 321         // revoke_and_ack                        ->
 322
 323         // First nodes[0] generates an update_fee
 324         let initial_feerate = get_feerate!(nodes[0], channel_id);
 325         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 326         check_added_monitors!(nodes[0], 1);
 327
 328         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 329         assert_eq!(events_0.len(), 1);
 330         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 331                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 332                         (update_fee.as_ref().unwrap(), commitment_signed)
 333                 },
 334                 _ => panic!("Unexpected event"),
 335         };
 336
 337         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 338         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 339         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 340         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 341         check_added_monitors!(nodes[1], 1);
 342
 343         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 344         // transaction:
 345         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 346         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 347         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 348
 349         // Create the (3) update_fee message that nodes[0] will generate before it does...
 350         let mut update_msg_2 = msgs::UpdateFee {
 351                 channel_id: update_msg_1.channel_id.clone(),
 352                 feerate_per_kw: (initial_feerate + 30) as u32,
 353         };
 354
 355         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 356
 357         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 358         // Deliver (3)
 359         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 360
 361         // Deliver (1), generating (3) and (4)
 362         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 363         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 364         check_added_monitors!(nodes[0], 1);
 365         assert!(as_second_update.update_add_htlcs.is_empty());
 366         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 367         assert!(as_second_update.update_fail_htlcs.is_empty());
 368         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 369         // Check that the update_fee newly generated matches what we delivered:
 370         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 371         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 372
 373         // Deliver (2) commitment_signed
 374         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 375         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 376         check_added_monitors!(nodes[0], 1);
 377         // No commitment_signed so get_event_msg's assert(len == 1) passes
 378
 379         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 380         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 381         check_added_monitors!(nodes[1], 1);
 382
 383         // Delever (4)
 384         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 385         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 386         check_added_monitors!(nodes[1], 1);
 387
 388         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 389         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 390         check_added_monitors!(nodes[0], 1);
 391
 392         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 393         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 394         // No commitment_signed so get_event_msg's assert(len == 1) passes
 395         check_added_monitors!(nodes[0], 1);
 396
 397         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 398         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 399         check_added_monitors!(nodes[1], 1);
 400 }
 401
 402 #[test]
 403 fn test_1_conf_open() {
 404         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 405         // tests that we properly send one in that case.
 406         let mut alice_config = UserConfig::default();
 407         alice_config.own_channel_config.minimum_depth = 1;
 408         alice_config.channel_options.announced_channel = true;
 409         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 410         let mut bob_config = UserConfig::default();
 411         bob_config.own_channel_config.minimum_depth = 1;
 412         bob_config.channel_options.announced_channel = true;
 413         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 414         let chanmon_cfgs = create_chanmon_cfgs(2);
 415         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 416         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 417         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 418
 419         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 420         let block = Block {
 421                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 422                 txdata: vec![tx],
 423         };
 424         connect_block(&nodes[1], &block, 1);
 425         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()));
 426
 427         connect_block(&nodes[0], &block, 1);
 428         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 429         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 430
 431         for node in nodes {
 432                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 433                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 434                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 435         }
 436 }
 437
 438 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 439         // Previously, we had issues deserializing channels when we hadn't connected the first block
 440         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 441         // serialization round-trips and simply do steps towards opening a channel and then drop the
 442         // Node objects.
 443
 444         let chanmon_cfgs = create_chanmon_cfgs(2);
 445         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 446         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 447         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 448
 449         if steps & 0b1000_0000 != 0{
 450                 let block = Block {
 451                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 452                         txdata: vec![],
 453                 };
 454                 connect_block(&nodes[0], &block, 1);
 455                 connect_block(&nodes[1], &block, 1);
 456         }
 457
 458         if steps & 0x0f == 0 { return; }
 459         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 460         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 461
 462         if steps & 0x0f == 1 { return; }
 463         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 464         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 465
 466         if steps & 0x0f == 2 { return; }
 467         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 468
 469         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 470
 471         if steps & 0x0f == 3 { return; }
 472         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 473         check_added_monitors!(nodes[0], 0);
 474         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 475
 476         if steps & 0x0f == 4 { return; }
 477         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 478         {
 479                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 480                 assert_eq!(added_monitors.len(), 1);
 481                 assert_eq!(added_monitors[0].0, funding_output);
 482                 added_monitors.clear();
 483         }
 484         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 485
 486         if steps & 0x0f == 5 { return; }
 487         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 488         {
 489                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 490                 assert_eq!(added_monitors.len(), 1);
 491                 assert_eq!(added_monitors[0].0, funding_output);
 492                 added_monitors.clear();
 493         }
 494
 495         let events_4 = nodes[0].node.get_and_clear_pending_events();
 496         assert_eq!(events_4.len(), 1);
 497         match events_4[0] {
 498                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 499                         assert_eq!(user_channel_id, 42);
 500                         assert_eq!(*funding_txo, funding_output);
 501                 },
 502                 _ => panic!("Unexpected event"),
 503         };
 504
 505         if steps & 0x0f == 6 { return; }
 506         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 507
 508         if steps & 0x0f == 7 { return; }
 509         confirm_transaction(&nodes[0], &tx);
 510         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 511 }
 512
 513 #[test]
 514 fn test_sanity_on_in_flight_opens() {
 515         do_test_sanity_on_in_flight_opens(0);
 516         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(1);
 518         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(2);
 520         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(3);
 522         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 523         do_test_sanity_on_in_flight_opens(4);
 524         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 525         do_test_sanity_on_in_flight_opens(5);
 526         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 527         do_test_sanity_on_in_flight_opens(6);
 528         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 529         do_test_sanity_on_in_flight_opens(7);
 530         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 531         do_test_sanity_on_in_flight_opens(8);
 532         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 533 }
 534
 535 #[test]
 536 fn test_update_fee_vanilla() {
 537         let chanmon_cfgs = create_chanmon_cfgs(2);
 538         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 539         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 540         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 541         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 542         let channel_id = chan.2;
 543
 544         let feerate = get_feerate!(nodes[0], channel_id);
 545         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 546         check_added_monitors!(nodes[0], 1);
 547
 548         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 549         assert_eq!(events_0.len(), 1);
 550         let (update_msg, commitment_signed) = match events_0[0] {
 551                         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 } } => {
 552                         (update_fee.as_ref(), commitment_signed)
 553                 },
 554                 _ => panic!("Unexpected event"),
 555         };
 556         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 557
 558         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 559         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 560         check_added_monitors!(nodes[1], 1);
 561
 562         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 563         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 564         check_added_monitors!(nodes[0], 1);
 565
 566         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 567         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 568         // No commitment_signed so get_event_msg's assert(len == 1) passes
 569         check_added_monitors!(nodes[0], 1);
 570
 571         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 572         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 573         check_added_monitors!(nodes[1], 1);
 574 }
 575
 576 #[test]
 577 fn test_update_fee_that_funder_cannot_afford() {
 578         let chanmon_cfgs = create_chanmon_cfgs(2);
 579         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 580         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 581         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 582         let channel_value = 1888;
 583         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 584         let channel_id = chan.2;
 585
 586         let feerate = 260;
 587         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 588         check_added_monitors!(nodes[0], 1);
 589         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 590
 591         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 592
 593         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 594
 595         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 596         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 597         {
 598                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 599
 600                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 601                 let num_htlcs = commitment_tx.output.len() - 2;
 602                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 603                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 604                 actual_fee = channel_value - actual_fee;
 605                 assert_eq!(total_fee, actual_fee);
 606         }
 607
 608         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 609         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 610         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 611         check_added_monitors!(nodes[0], 1);
 612
 613         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 614
 615         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 616
 617         //While producing the commitment_signed response after handling a received update_fee request the
 618         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 619         //Should produce and error.
 620         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 621         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 622         check_added_monitors!(nodes[1], 1);
 623         check_closed_broadcast!(nodes[1], true);
 624 }
 625
 626 #[test]
 627 fn test_update_fee_with_fundee_update_add_htlc() {
 628         let chanmon_cfgs = create_chanmon_cfgs(2);
 629         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 630         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 631         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 632         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 633         let channel_id = chan.2;
 634         let logger = test_utils::TestLogger::new();
 635
 636         // balancing
 637         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 638
 639         let feerate = get_feerate!(nodes[0], channel_id);
 640         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 641         check_added_monitors!(nodes[0], 1);
 642
 643         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 644         assert_eq!(events_0.len(), 1);
 645         let (update_msg, commitment_signed) = match events_0[0] {
 646                         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 } } => {
 647                         (update_fee.as_ref(), commitment_signed)
 648                 },
 649                 _ => panic!("Unexpected event"),
 650         };
 651         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 652         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 653         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 654         check_added_monitors!(nodes[1], 1);
 655
 656         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 657         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 658         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();
 659
 660         // nothing happens since node[1] is in AwaitingRemoteRevoke
 661         nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
 662         {
 663                 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
 664                 assert_eq!(added_monitors.len(), 0);
 665                 added_monitors.clear();
 666         }
 667         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 668         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 669         // node[1] has nothing to do
 670
 671         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 672         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 673         check_added_monitors!(nodes[0], 1);
 674
 675         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 676         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 677         // No commitment_signed so get_event_msg's assert(len == 1) passes
 678         check_added_monitors!(nodes[0], 1);
 679         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 680         check_added_monitors!(nodes[1], 1);
 681         // AwaitingRemoteRevoke ends here
 682
 683         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 684         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 685         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 686         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 687         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 688         assert_eq!(commitment_update.update_fee.is_none(), true);
 689
 690         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 691         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 692         check_added_monitors!(nodes[0], 1);
 693         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 694
 695         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 696         check_added_monitors!(nodes[1], 1);
 697         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 698
 699         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 700         check_added_monitors!(nodes[1], 1);
 701         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 702         // No commitment_signed so get_event_msg's assert(len == 1) passes
 703
 704         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 705         check_added_monitors!(nodes[0], 1);
 706         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 707
 708         expect_pending_htlcs_forwardable!(nodes[0]);
 709
 710         let events = nodes[0].node.get_and_clear_pending_events();
 711         assert_eq!(events.len(), 1);
 712         match events[0] {
 713                 Event::PaymentReceived { .. } => { },
 714                 _ => panic!("Unexpected event"),
 715         };
 716
 717         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 718
 719         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 720         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 721         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 722 }
 723
 724 #[test]
 725 fn test_update_fee() {
 726         let chanmon_cfgs = create_chanmon_cfgs(2);
 727         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 728         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 729         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 730         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 731         let channel_id = chan.2;
 732
 733         // A                                        B
 734         // (1) update_fee/commitment_signed      ->
 735         //                                       <- (2) revoke_and_ack
 736         //                                       .- send (3) commitment_signed
 737         // (4) update_fee/commitment_signed      ->
 738         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 739         //                                       <- (3) commitment_signed delivered
 740         // send (6) revoke_and_ack               -.
 741         //                                       <- (5) deliver revoke_and_ack
 742         // (6) deliver revoke_and_ack            ->
 743         //                                       .- send (7) commitment_signed in response to (4)
 744         //                                       <- (7) deliver commitment_signed
 745         // revoke_and_ack                        ->
 746
 747         // Create and deliver (1)...
 748         let feerate = get_feerate!(nodes[0], channel_id);
 749         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 750         check_added_monitors!(nodes[0], 1);
 751
 752         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 753         assert_eq!(events_0.len(), 1);
 754         let (update_msg, commitment_signed) = match events_0[0] {
 755                         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 } } => {
 756                         (update_fee.as_ref(), commitment_signed)
 757                 },
 758                 _ => panic!("Unexpected event"),
 759         };
 760         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 761
 762         // Generate (2) and (3):
 763         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 764         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 765         check_added_monitors!(nodes[1], 1);
 766
 767         // Deliver (2):
 768         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 769         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 770         check_added_monitors!(nodes[0], 1);
 771
 772         // Create and deliver (4)...
 773         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 774         check_added_monitors!(nodes[0], 1);
 775         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 776         assert_eq!(events_0.len(), 1);
 777         let (update_msg, commitment_signed) = match events_0[0] {
 778                         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 } } => {
 779                         (update_fee.as_ref(), commitment_signed)
 780                 },
 781                 _ => panic!("Unexpected event"),
 782         };
 783
 784         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 785         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 786         check_added_monitors!(nodes[1], 1);
 787         // ... creating (5)
 788         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 789         // No commitment_signed so get_event_msg's assert(len == 1) passes
 790
 791         // Handle (3), creating (6):
 792         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 793         check_added_monitors!(nodes[0], 1);
 794         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 795         // No commitment_signed so get_event_msg's assert(len == 1) passes
 796
 797         // Deliver (5):
 798         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 799         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 800         check_added_monitors!(nodes[0], 1);
 801
 802         // Deliver (6), creating (7):
 803         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 804         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 805         assert!(commitment_update.update_add_htlcs.is_empty());
 806         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 807         assert!(commitment_update.update_fail_htlcs.is_empty());
 808         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 809         assert!(commitment_update.update_fee.is_none());
 810         check_added_monitors!(nodes[1], 1);
 811
 812         // Deliver (7)
 813         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 814         check_added_monitors!(nodes[0], 1);
 815         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 816         // No commitment_signed so get_event_msg's assert(len == 1) passes
 817
 818         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 819         check_added_monitors!(nodes[1], 1);
 820         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 821
 822         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 823         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 824         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 825 }
 826
 827 #[test]
 828 fn pre_funding_lock_shutdown_test() {
 829         // Test sending a shutdown prior to funding_locked after funding generation
 830         let chanmon_cfgs = create_chanmon_cfgs(2);
 831         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 832         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 833         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 834         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 835         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 836         connect_block(&nodes[0], &Block { header, txdata: vec![tx.clone()]}, 1);
 837         connect_block(&nodes[1], &Block { header, txdata: vec![tx.clone()]}, 1);
 838
 839         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 840         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 841         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 842         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 843         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 844
 845         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 846         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 847         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 848         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 849         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 850         assert!(node_0_none.is_none());
 851
 852         assert!(nodes[0].node.list_channels().is_empty());
 853         assert!(nodes[1].node.list_channels().is_empty());
 854 }
 855
 856 #[test]
 857 fn updates_shutdown_wait() {
 858         // Test sending a shutdown with outstanding updates pending
 859         let chanmon_cfgs = create_chanmon_cfgs(3);
 860         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 861         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 862         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 863         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 864         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 865         let logger = test_utils::TestLogger::new();
 866
 867         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 868
 869         nodes[0].node.close_channel(&chan_1.2).unwrap();
 870         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 871         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 872         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 873         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 874
 875         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 876         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 877
 878         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 879
 880         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 881         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 882         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();
 883         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();
 884         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 885         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 886
 887         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 888         check_added_monitors!(nodes[2], 1);
 889         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 890         assert!(updates.update_add_htlcs.is_empty());
 891         assert!(updates.update_fail_htlcs.is_empty());
 892         assert!(updates.update_fail_malformed_htlcs.is_empty());
 893         assert!(updates.update_fee.is_none());
 894         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 895         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 896         check_added_monitors!(nodes[1], 1);
 897         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 898         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 899
 900         assert!(updates_2.update_add_htlcs.is_empty());
 901         assert!(updates_2.update_fail_htlcs.is_empty());
 902         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 903         assert!(updates_2.update_fee.is_none());
 904         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 905         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 906         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 907
 908         let events = nodes[0].node.get_and_clear_pending_events();
 909         assert_eq!(events.len(), 1);
 910         match events[0] {
 911                 Event::PaymentSent { ref payment_preimage } => {
 912                         assert_eq!(our_payment_preimage, *payment_preimage);
 913                 },
 914                 _ => panic!("Unexpected event"),
 915         }
 916
 917         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 918         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 919         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 920         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 921         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 922         assert!(node_0_none.is_none());
 923
 924         assert!(nodes[0].node.list_channels().is_empty());
 925
 926         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 927         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 928         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 929         assert!(nodes[1].node.list_channels().is_empty());
 930         assert!(nodes[2].node.list_channels().is_empty());
 931 }
 932
 933 #[test]
 934 fn htlc_fail_async_shutdown() {
 935         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 936         let chanmon_cfgs = create_chanmon_cfgs(3);
 937         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 938         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 939         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 940         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 941         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 942         let logger = test_utils::TestLogger::new();
 943
 944         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 945         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 946         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();
 947         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
 948         check_added_monitors!(nodes[0], 1);
 949         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 950         assert_eq!(updates.update_add_htlcs.len(), 1);
 951         assert!(updates.update_fulfill_htlcs.is_empty());
 952         assert!(updates.update_fail_htlcs.is_empty());
 953         assert!(updates.update_fail_malformed_htlcs.is_empty());
 954         assert!(updates.update_fee.is_none());
 955
 956         nodes[1].node.close_channel(&chan_1.2).unwrap();
 957         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 958         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 959         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 960
 961         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 962         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 963         check_added_monitors!(nodes[1], 1);
 964         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 965         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 966
 967         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 968         assert!(updates_2.update_add_htlcs.is_empty());
 969         assert!(updates_2.update_fulfill_htlcs.is_empty());
 970         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 971         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 972         assert!(updates_2.update_fee.is_none());
 973
 974         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 975         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 976
 977         expect_payment_failed!(nodes[0], our_payment_hash, false);
 978
 979         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 980         assert_eq!(msg_events.len(), 2);
 981         let node_0_closing_signed = match msg_events[0] {
 982                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 983                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 984                         (*msg).clone()
 985                 },
 986                 _ => panic!("Unexpected event"),
 987         };
 988         match msg_events[1] {
 989                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 990                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 991                 },
 992                 _ => panic!("Unexpected event"),
 993         }
 994
 995         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 996         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 997         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 998         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 999         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1000         assert!(node_0_none.is_none());
1001
1002         assert!(nodes[0].node.list_channels().is_empty());
1003
1004         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1005         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1006         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1007         assert!(nodes[1].node.list_channels().is_empty());
1008         assert!(nodes[2].node.list_channels().is_empty());
1009 }
1010
1011 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1012         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1013         // messages delivered prior to disconnect
1014         let chanmon_cfgs = create_chanmon_cfgs(3);
1015         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1016         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1017         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1018         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1019         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1020
1021         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1022
1023         nodes[1].node.close_channel(&chan_1.2).unwrap();
1024         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1025         if recv_count > 0 {
1026                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1027                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1028                 if recv_count > 1 {
1029                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1030                 }
1031         }
1032
1033         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1034         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1035
1036         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1037         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1038         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1039         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1040
1041         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1042         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1043         assert!(node_1_shutdown == node_1_2nd_shutdown);
1044
1045         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1046         let node_0_2nd_shutdown = if recv_count > 0 {
1047                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1048                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1049                 node_0_2nd_shutdown
1050         } else {
1051                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1052                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1053                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1054         };
1055         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1056
1057         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1058         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1059
1060         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1061         check_added_monitors!(nodes[2], 1);
1062         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1063         assert!(updates.update_add_htlcs.is_empty());
1064         assert!(updates.update_fail_htlcs.is_empty());
1065         assert!(updates.update_fail_malformed_htlcs.is_empty());
1066         assert!(updates.update_fee.is_none());
1067         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1068         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1069         check_added_monitors!(nodes[1], 1);
1070         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1071         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1072
1073         assert!(updates_2.update_add_htlcs.is_empty());
1074         assert!(updates_2.update_fail_htlcs.is_empty());
1075         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1076         assert!(updates_2.update_fee.is_none());
1077         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1078         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1079         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1080
1081         let events = nodes[0].node.get_and_clear_pending_events();
1082         assert_eq!(events.len(), 1);
1083         match events[0] {
1084                 Event::PaymentSent { ref payment_preimage } => {
1085                         assert_eq!(our_payment_preimage, *payment_preimage);
1086                 },
1087                 _ => panic!("Unexpected event"),
1088         }
1089
1090         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1091         if recv_count > 0 {
1092                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1093                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1094                 assert!(node_1_closing_signed.is_some());
1095         }
1096
1097         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1098         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1099
1100         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1101         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1102         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1103         if recv_count == 0 {
1104                 // If all closing_signeds weren't delivered we can just resume where we left off...
1105                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1106
1107                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1108                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1109                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1110
1111                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1112                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1113                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1114
1115                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1116                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1117
1118                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1119                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1120                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1121
1122                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1123                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1124                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1125                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1126                 assert!(node_0_none.is_none());
1127         } else {
1128                 // If one node, however, received + responded with an identical closing_signed we end
1129                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1130                 // There isn't really anything better we can do simply, but in the future we might
1131                 // explore storing a set of recently-closed channels that got disconnected during
1132                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1133                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1134                 // transaction.
1135                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1136
1137                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1138                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1139                 assert_eq!(msg_events.len(), 1);
1140                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1141                         match action {
1142                                 &ErrorAction::SendErrorMessage { ref msg } => {
1143                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1144                                         assert_eq!(msg.channel_id, chan_1.2);
1145                                 },
1146                                 _ => panic!("Unexpected event!"),
1147                         }
1148                 } else { panic!("Needed SendErrorMessage close"); }
1149
1150                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1151                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1152                 // closing_signed so we do it ourselves
1153                 check_closed_broadcast!(nodes[0], false);
1154                 check_added_monitors!(nodes[0], 1);
1155         }
1156
1157         assert!(nodes[0].node.list_channels().is_empty());
1158
1159         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1160         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1161         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1162         assert!(nodes[1].node.list_channels().is_empty());
1163         assert!(nodes[2].node.list_channels().is_empty());
1164 }
1165
1166 #[test]
1167 fn test_shutdown_rebroadcast() {
1168         do_test_shutdown_rebroadcast(0);
1169         do_test_shutdown_rebroadcast(1);
1170         do_test_shutdown_rebroadcast(2);
1171 }
1172
1173 #[test]
1174 fn fake_network_test() {
1175         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1176         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1177         let chanmon_cfgs = create_chanmon_cfgs(4);
1178         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1179         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1180         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1181
1182         // Create some initial channels
1183         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1184         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1185         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1186
1187         // Rebalance the network a bit by relaying one payment through all the channels...
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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1191         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1192
1193         // Send some more payments
1194         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1195         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1196         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1197
1198         // Test failure packets
1199         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1200         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1201
1202         // Add a new channel that skips 3
1203         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1204
1205         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1206         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_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         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1211         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1212
1213         // Do some rebalance loop payments, simultaneously
1214         let mut hops = Vec::with_capacity(3);
1215         hops.push(RouteHop {
1216                 pubkey: nodes[2].node.get_our_node_id(),
1217                 node_features: NodeFeatures::empty(),
1218                 short_channel_id: chan_2.0.contents.short_channel_id,
1219                 channel_features: ChannelFeatures::empty(),
1220                 fee_msat: 0,
1221                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1222         });
1223         hops.push(RouteHop {
1224                 pubkey: nodes[3].node.get_our_node_id(),
1225                 node_features: NodeFeatures::empty(),
1226                 short_channel_id: chan_3.0.contents.short_channel_id,
1227                 channel_features: ChannelFeatures::empty(),
1228                 fee_msat: 0,
1229                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1230         });
1231         hops.push(RouteHop {
1232                 pubkey: nodes[1].node.get_our_node_id(),
1233                 node_features: NodeFeatures::empty(),
1234                 short_channel_id: chan_4.0.contents.short_channel_id,
1235                 channel_features: ChannelFeatures::empty(),
1236                 fee_msat: 1000000,
1237                 cltv_expiry_delta: TEST_FINAL_CLTV,
1238         });
1239         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;
1240         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;
1241         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1242
1243         let mut hops = Vec::with_capacity(3);
1244         hops.push(RouteHop {
1245                 pubkey: nodes[3].node.get_our_node_id(),
1246                 node_features: NodeFeatures::empty(),
1247                 short_channel_id: chan_4.0.contents.short_channel_id,
1248                 channel_features: ChannelFeatures::empty(),
1249                 fee_msat: 0,
1250                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1251         });
1252         hops.push(RouteHop {
1253                 pubkey: nodes[2].node.get_our_node_id(),
1254                 node_features: NodeFeatures::empty(),
1255                 short_channel_id: chan_3.0.contents.short_channel_id,
1256                 channel_features: ChannelFeatures::empty(),
1257                 fee_msat: 0,
1258                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1259         });
1260         hops.push(RouteHop {
1261                 pubkey: nodes[1].node.get_our_node_id(),
1262                 node_features: NodeFeatures::empty(),
1263                 short_channel_id: chan_2.0.contents.short_channel_id,
1264                 channel_features: ChannelFeatures::empty(),
1265                 fee_msat: 1000000,
1266                 cltv_expiry_delta: TEST_FINAL_CLTV,
1267         });
1268         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;
1269         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;
1270         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1271
1272         // Claim the rebalances...
1273         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1274         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1275
1276         // Add a duplicate new channel from 2 to 4
1277         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1278
1279         // Send some payments across both channels
1280         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1281         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1282         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1283
1284
1285         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1286         let events = nodes[0].node.get_and_clear_pending_msg_events();
1287         assert_eq!(events.len(), 0);
1288         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);
1289
1290         //TODO: Test that routes work again here as we've been notified that the channel is full
1291
1292         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1293         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1294         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1295
1296         // Close down the channels...
1297         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1298         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1299         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1300         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1301         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1302 }
1303
1304 #[test]
1305 fn holding_cell_htlc_counting() {
1306         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1307         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1308         // commitment dance rounds.
1309         let chanmon_cfgs = create_chanmon_cfgs(3);
1310         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1311         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1312         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1313         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1314         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1315         let logger = test_utils::TestLogger::new();
1316
1317         let mut payments = Vec::new();
1318         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1319                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1320                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1321                 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();
1322                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1323                 payments.push((payment_preimage, payment_hash));
1324         }
1325         check_added_monitors!(nodes[1], 1);
1326
1327         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1328         assert_eq!(events.len(), 1);
1329         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1330         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1331
1332         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1333         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1334         // another HTLC.
1335         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1336         {
1337                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1338                 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();
1339                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1340                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1341                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1342                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1343         }
1344
1345         // This should also be true if we try to forward a payment.
1346         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1347         {
1348                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1349                 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();
1350                 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1351                 check_added_monitors!(nodes[0], 1);
1352         }
1353
1354         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1355         assert_eq!(events.len(), 1);
1356         let payment_event = SendEvent::from_event(events.pop().unwrap());
1357         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1358
1359         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1360         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1361         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1362         // fails), the second will process the resulting failure and fail the HTLC backward.
1363         expect_pending_htlcs_forwardable!(nodes[1]);
1364         expect_pending_htlcs_forwardable!(nodes[1]);
1365         check_added_monitors!(nodes[1], 1);
1366
1367         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1368         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1369         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1370
1371         let events = nodes[0].node.get_and_clear_pending_msg_events();
1372         assert_eq!(events.len(), 1);
1373         match events[0] {
1374                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1375                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1376                 },
1377                 _ => panic!("Unexpected event"),
1378         }
1379
1380         expect_payment_failed!(nodes[0], payment_hash_2, false);
1381
1382         // Now forward all the pending HTLCs and claim them back
1383         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1384         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1385         check_added_monitors!(nodes[2], 1);
1386
1387         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1388         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1389         check_added_monitors!(nodes[1], 1);
1390         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1391
1392         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1393         check_added_monitors!(nodes[1], 1);
1394         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1395
1396         for ref update in as_updates.update_add_htlcs.iter() {
1397                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1398         }
1399         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1400         check_added_monitors!(nodes[2], 1);
1401         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1402         check_added_monitors!(nodes[2], 1);
1403         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1404
1405         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1406         check_added_monitors!(nodes[1], 1);
1407         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1408         check_added_monitors!(nodes[1], 1);
1409         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1410
1411         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1412         check_added_monitors!(nodes[2], 1);
1413
1414         expect_pending_htlcs_forwardable!(nodes[2]);
1415
1416         let events = nodes[2].node.get_and_clear_pending_events();
1417         assert_eq!(events.len(), payments.len());
1418         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1419                 match event {
1420                         &Event::PaymentReceived { ref payment_hash, .. } => {
1421                                 assert_eq!(*payment_hash, *hash);
1422                         },
1423                         _ => panic!("Unexpected event"),
1424                 };
1425         }
1426
1427         for (preimage, _) in payments.drain(..) {
1428                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1429         }
1430
1431         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1432 }
1433
1434 #[test]
1435 fn duplicate_htlc_test() {
1436         // Test that we accept duplicate payment_hash HTLCs across the network and that
1437         // claiming/failing them are all separate and don't affect each other
1438         let chanmon_cfgs = create_chanmon_cfgs(6);
1439         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1440         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1441         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1442
1443         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1444         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1445         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1446         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1447         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1448         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1449
1450         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1451
1452         *nodes[0].network_payment_count.borrow_mut() -= 1;
1453         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1454
1455         *nodes[0].network_payment_count.borrow_mut() -= 1;
1456         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1457
1458         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1459         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1460         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1461 }
1462
1463 #[test]
1464 fn test_duplicate_htlc_different_direction_onchain() {
1465         // Test that ChannelMonitor doesn't generate 2 preimage txn
1466         // when we have 2 HTLCs with same preimage that go across a node
1467         // in opposite directions.
1468         let chanmon_cfgs = create_chanmon_cfgs(2);
1469         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1470         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1471         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1472
1473         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1474         let logger = test_utils::TestLogger::new();
1475
1476         // balancing
1477         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1478
1479         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1480
1481         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1482         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();
1483         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1484
1485         // Provide preimage to node 0 by claiming payment
1486         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1487         check_added_monitors!(nodes[0], 1);
1488
1489         // Broadcast node 1 commitment txn
1490         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1491
1492         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1493         let mut has_both_htlcs = 0; // check htlcs match ones committed
1494         for outp in remote_txn[0].output.iter() {
1495                 if outp.value == 800_000 / 1000 {
1496                         has_both_htlcs += 1;
1497                 } else if outp.value == 900_000 / 1000 {
1498                         has_both_htlcs += 1;
1499                 }
1500         }
1501         assert_eq!(has_both_htlcs, 2);
1502
1503         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1504         connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1505         check_added_monitors!(nodes[0], 1);
1506
1507         // Check we only broadcast 1 timeout tx
1508         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1509         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()) };
1510         assert_eq!(claim_txn.len(), 5);
1511         check_spends!(claim_txn[2], chan_1.3);
1512         check_spends!(claim_txn[3], claim_txn[2]);
1513         assert_eq!(htlc_pair.0.input.len(), 1);
1514         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1515         check_spends!(htlc_pair.0, remote_txn[0]);
1516         assert_eq!(htlc_pair.1.input.len(), 1);
1517         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1518         check_spends!(htlc_pair.1, remote_txn[0]);
1519
1520         let events = nodes[0].node.get_and_clear_pending_msg_events();
1521         assert_eq!(events.len(), 2);
1522         for e in events {
1523                 match e {
1524                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1525                         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, .. } } => {
1526                                 assert!(update_add_htlcs.is_empty());
1527                                 assert!(update_fail_htlcs.is_empty());
1528                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1529                                 assert!(update_fail_malformed_htlcs.is_empty());
1530                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1531                         },
1532                         _ => panic!("Unexpected event"),
1533                 }
1534         }
1535 }
1536
1537 #[test]
1538 fn test_basic_channel_reserve() {
1539         let chanmon_cfgs = create_chanmon_cfgs(2);
1540         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1541         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1542         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1543         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1544         let logger = test_utils::TestLogger::new();
1545
1546         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1547         let channel_reserve = chan_stat.channel_reserve_msat;
1548
1549         // The 2* and +1 are for the fee spike reserve.
1550         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1551         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1552         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1553         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1554         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();
1555         let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1556         match err {
1557                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1558                         match &fails[0] {
1559                                 &APIError::ChannelUnavailable{ref err} =>
1560                                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
1561                                 _ => panic!("Unexpected error variant"),
1562                         }
1563                 },
1564                 _ => panic!("Unexpected error variant"),
1565         }
1566         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1567         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1568
1569         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1570 }
1571
1572 #[test]
1573 fn test_fee_spike_violation_fails_htlc() {
1574         let chanmon_cfgs = create_chanmon_cfgs(2);
1575         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1576         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1577         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1578         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1579         let logger = test_utils::TestLogger::new();
1580
1581         macro_rules! get_route_and_payment_hash {
1582                 ($recv_value: expr) => {{
1583                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1584                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
1585                         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();
1586                         (route, payment_hash, payment_preimage)
1587                 }}
1588         };
1589
1590         let (route, payment_hash, _) = get_route_and_payment_hash!(3460001);
1591         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1592         let secp_ctx = Secp256k1::new();
1593         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1594
1595         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1596
1597         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1598         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1599         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1600         let msg = msgs::UpdateAddHTLC {
1601                 channel_id: chan.2,
1602                 htlc_id: 0,
1603                 amount_msat: htlc_msat,
1604                 payment_hash: payment_hash,
1605                 cltv_expiry: htlc_cltv,
1606                 onion_routing_packet: onion_packet,
1607         };
1608
1609         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1610
1611         // Now manually create the commitment_signed message corresponding to the update_add
1612         // nodes[0] just sent. In the code for construction of this message, "local" refers
1613         // to the sender of the message, and "remote" refers to the receiver.
1614
1615         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1616
1617         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1618
1619         // Get the EnforcingChannelKeys for each channel, which will be used to (1) get the keys
1620         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1621         let (local_revocation_basepoint, local_htlc_basepoint, local_payment_point, local_secret, local_secret2) = {
1622                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1623                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1624                 let chan_keys = local_chan.get_keys();
1625                 let pubkeys = chan_keys.pubkeys();
1626                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1627                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER), chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2))
1628         };
1629         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_payment_point, remote_secret1) = {
1630                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1631                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1632                 let chan_keys = remote_chan.get_keys();
1633                 let pubkeys = chan_keys.pubkeys();
1634                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1635                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1))
1636         };
1637
1638         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1639         let commitment_secret = SecretKey::from_slice(&remote_secret1).unwrap();
1640         let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &commitment_secret);
1641         let commit_tx_keys = chan_utils::TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, &remote_delayed_payment_basepoint,
1642                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1643
1644         // Build the remote commitment transaction so we can sign it, and then later use the
1645         // signature for the commitment_signed message.
1646         let local_chan_balance = 1313;
1647         let static_payment_pk = local_payment_point.serialize();
1648         let remote_commit_tx_output = TxOut {
1649                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1650                                                              .push_slice(&WPubkeyHash::hash(&static_payment_pk)[..])
1651                                                              .into_script(),
1652                 value: local_chan_balance as u64
1653         };
1654
1655         let local_commit_tx_output = TxOut {
1656                 script_pubkey: chan_utils::get_revokeable_redeemscript(&commit_tx_keys.revocation_key,
1657                                                                                BREAKDOWN_TIMEOUT,
1658                                                                                &commit_tx_keys.broadcaster_delayed_payment_key).to_v0_p2wsh(),
1659                                 value: 95000,
1660         };
1661
1662         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1663                 offered: false,
1664                 amount_msat: 3460001,
1665                 cltv_expiry: htlc_cltv,
1666                 payment_hash: payment_hash,
1667                 transaction_output_index: Some(1),
1668         };
1669
1670         let htlc_output = TxOut {
1671                 script_pubkey: chan_utils::get_htlc_redeemscript(&accepted_htlc_info, &commit_tx_keys).to_v0_p2wsh(),
1672                 value: 3460001 / 1000
1673         };
1674
1675         let commit_tx_obscure_factor = {
1676                 let mut sha = Sha256::engine();
1677                 let remote_payment_point = &remote_payment_point.serialize();
1678                 sha.input(&local_payment_point.serialize());
1679                 sha.input(remote_payment_point);
1680                 let res = Sha256::from_engine(sha).into_inner();
1681
1682                 ((res[26] as u64) << 5*8) |
1683                 ((res[27] as u64) << 4*8) |
1684                 ((res[28] as u64) << 3*8) |
1685                 ((res[29] as u64) << 2*8) |
1686                 ((res[30] as u64) << 1*8) |
1687                 ((res[31] as u64) << 0*8)
1688         };
1689         let commitment_number = 1;
1690         let obscured_commitment_transaction_number = commit_tx_obscure_factor ^ commitment_number;
1691         let lock_time = ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32);
1692         let input = TxIn {
1693                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
1694                 script_sig: Script::new(),
1695                 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
1696                 witness: Vec::new(),
1697         };
1698
1699         let commit_tx = Transaction {
1700                 version: 2,
1701                 lock_time,
1702                 input: vec![input],
1703                 output: vec![remote_commit_tx_output, htlc_output, local_commit_tx_output],
1704         };
1705         let res = {
1706                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1707                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1708                 let local_chan_keys = local_chan.get_keys();
1709                 let pre_commit_tx_keys = PreCalculatedTxCreationKeys::new(commit_tx_keys);
1710                 local_chan_keys.sign_counterparty_commitment(feerate_per_kw, &commit_tx, &pre_commit_tx_keys, &[&accepted_htlc_info], &secp_ctx).unwrap()
1711         };
1712
1713         let commit_signed_msg = msgs::CommitmentSigned {
1714                 channel_id: chan.2,
1715                 signature: res.0,
1716                 htlc_signatures: res.1
1717         };
1718
1719         // Send the commitment_signed message to the nodes[1].
1720         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1721         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1722
1723         // Send the RAA to nodes[1].
1724         let per_commitment_secret = local_secret;
1725         let next_secret = SecretKey::from_slice(&local_secret2).unwrap();
1726         let next_per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &next_secret);
1727         let raa_msg = msgs::RevokeAndACK{ channel_id: chan.2, per_commitment_secret, next_per_commitment_point};
1728         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1729
1730         let events = nodes[1].node.get_and_clear_pending_msg_events();
1731         assert_eq!(events.len(), 1);
1732         // Make sure the HTLC failed in the way we expect.
1733         match events[0] {
1734                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1735                         assert_eq!(update_fail_htlcs.len(), 1);
1736                         update_fail_htlcs[0].clone()
1737                 },
1738                 _ => panic!("Unexpected event"),
1739         };
1740         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1741
1742         check_added_monitors!(nodes[1], 2);
1743 }
1744
1745 #[test]
1746 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1747         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1748         // Set the fee rate for the channel very high, to the point where the fundee
1749         // sending any amount would result in a channel reserve violation. In this test
1750         // we check that we would be prevented from sending an HTLC in this situation.
1751         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1752         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1753         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1754         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1755         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1756         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1757         let logger = test_utils::TestLogger::new();
1758
1759         macro_rules! get_route_and_payment_hash {
1760                 ($recv_value: expr) => {{
1761                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1762                         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1763                         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();
1764                         (route, payment_hash, payment_preimage)
1765                 }}
1766         };
1767
1768         let (route, our_payment_hash, _) = get_route_and_payment_hash!(1000);
1769         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1770                 assert_eq!(err, "Cannot send value that would put counterparty balance under holder-announced channel reserve value"));
1771         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1772         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_string(), 1);
1773 }
1774
1775 #[test]
1776 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1777         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1778         // Set the fee rate for the channel very high, to the point where the funder
1779         // receiving 1 update_add_htlc would result in them closing the channel due
1780         // to channel reserve violation. This close could also happen if the fee went
1781         // up a more realistic amount, but many HTLCs were outstanding at the time of
1782         // the update_add_htlc.
1783         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1784         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1785         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1786         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1787         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1788         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1789         let logger = test_utils::TestLogger::new();
1790
1791         macro_rules! get_route_and_payment_hash {
1792                 ($recv_value: expr) => {{
1793                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1794                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1795                         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();
1796                         (route, payment_hash, payment_preimage)
1797                 }}
1798         };
1799
1800         let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1801         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1802         let secp_ctx = Secp256k1::new();
1803         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1804         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1805         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1806         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1807         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1808         let msg = msgs::UpdateAddHTLC {
1809                 channel_id: chan.2,
1810                 htlc_id: 1,
1811                 amount_msat: htlc_msat + 1,
1812                 payment_hash: payment_hash,
1813                 cltv_expiry: htlc_cltv,
1814                 onion_routing_packet: onion_packet,
1815         };
1816
1817         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1818         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1819         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_string(), 1);
1820         assert_eq!(nodes[0].node.list_channels().len(), 0);
1821         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1822         assert_eq!(err_msg.data, "Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value");
1823         check_added_monitors!(nodes[0], 1);
1824 }
1825
1826 #[test]
1827 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1828         let chanmon_cfgs = create_chanmon_cfgs(3);
1829         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1830         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1831         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1832         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1833         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1834         let logger = test_utils::TestLogger::new();
1835
1836         macro_rules! get_route_and_payment_hash {
1837                 ($recv_value: expr) => {{
1838                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1839                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1840                         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();
1841                         (route, payment_hash, payment_preimage)
1842                 }}
1843         };
1844
1845         let feemsat = 239;
1846         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1847         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1848         let feerate = get_feerate!(nodes[0], chan.2);
1849
1850         // Add a 2* and +1 for the fee spike reserve.
1851         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1852         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;
1853         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1854
1855         // Add a pending HTLC.
1856         let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1857         let payment_event_1 = {
1858                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1859                 check_added_monitors!(nodes[0], 1);
1860
1861                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1862                 assert_eq!(events.len(), 1);
1863                 SendEvent::from_event(events.remove(0))
1864         };
1865         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1866
1867         // Attempt to trigger a channel reserve violation --> payment failure.
1868         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1869         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;
1870         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1871         let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1872
1873         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1874         let secp_ctx = Secp256k1::new();
1875         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1876         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1877         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1878         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1879         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1880         let msg = msgs::UpdateAddHTLC {
1881                 channel_id: chan.2,
1882                 htlc_id: 1,
1883                 amount_msat: htlc_msat + 1,
1884                 payment_hash: our_payment_hash_1,
1885                 cltv_expiry: htlc_cltv,
1886                 onion_routing_packet: onion_packet,
1887         };
1888
1889         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1890         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1891         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1892         assert_eq!(nodes[1].node.list_channels().len(), 1);
1893         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1894         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1895         check_added_monitors!(nodes[1], 1);
1896 }
1897
1898 #[test]
1899 fn test_inbound_outbound_capacity_is_not_zero() {
1900         let chanmon_cfgs = create_chanmon_cfgs(2);
1901         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1902         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1903         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1904         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1905         let channels0 = node_chanmgrs[0].list_channels();
1906         let channels1 = node_chanmgrs[1].list_channels();
1907         assert_eq!(channels0.len(), 1);
1908         assert_eq!(channels1.len(), 1);
1909
1910         assert_eq!(channels0[0].inbound_capacity_msat, 95000000);
1911         assert_eq!(channels1[0].outbound_capacity_msat, 95000000);
1912
1913         assert_eq!(channels0[0].outbound_capacity_msat, 100000 * 1000 - 95000000);
1914         assert_eq!(channels1[0].inbound_capacity_msat, 100000 * 1000 - 95000000);
1915 }
1916
1917 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1918         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1919 }
1920
1921 #[test]
1922 fn test_channel_reserve_holding_cell_htlcs() {
1923         let chanmon_cfgs = create_chanmon_cfgs(3);
1924         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1925         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1926         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1927         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1928         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1929         let logger = test_utils::TestLogger::new();
1930
1931         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1932         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1933
1934         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1935         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1936
1937         macro_rules! get_route_and_payment_hash {
1938                 ($recv_value: expr) => {{
1939                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1940                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1941                         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();
1942                         (route, payment_hash, payment_preimage)
1943                 }}
1944         };
1945
1946         macro_rules! expect_forward {
1947                 ($node: expr) => {{
1948                         let mut events = $node.node.get_and_clear_pending_msg_events();
1949                         assert_eq!(events.len(), 1);
1950                         check_added_monitors!($node, 1);
1951                         let payment_event = SendEvent::from_event(events.remove(0));
1952                         payment_event
1953                 }}
1954         }
1955
1956         let feemsat = 239; // somehow we know?
1957         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1958         let feerate = get_feerate!(nodes[0], chan_1.2);
1959
1960         let recv_value_0 = stat01.counterparty_max_htlc_value_in_flight_msat - total_fee_msat;
1961
1962         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1963         {
1964                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1965                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1966                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1967                         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)));
1968                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1969                 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);
1970         }
1971
1972         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1973         // nodes[0]'s wealth
1974         loop {
1975                 let amt_msat = recv_value_0 + total_fee_msat;
1976                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1977                 // Also, ensure that each payment has enough to be over the dust limit to
1978                 // ensure it'll be included in each commit tx fee calculation.
1979                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1980                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.counterparty_dust_limit_msat + 1000);
1981                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1982                         break;
1983                 }
1984                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1985
1986                 let (stat01_, stat11_, stat12_, stat22_) = (
1987                         get_channel_value_stat!(nodes[0], chan_1.2),
1988                         get_channel_value_stat!(nodes[1], chan_1.2),
1989                         get_channel_value_stat!(nodes[1], chan_2.2),
1990                         get_channel_value_stat!(nodes[2], chan_2.2),
1991                 );
1992
1993                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1994                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1995                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1996                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1997                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1998         }
1999
2000         // adding pending output.
2001         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
2002         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
2003         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
2004         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
2005         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
2006         // cases where 1 msat over X amount will cause a payment failure, but anything less than
2007         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
2008         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
2009         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
2010         // policy.
2011         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
2012         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
2013         let amt_msat_1 = recv_value_1 + total_fee_msat;
2014
2015         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
2016         let payment_event_1 = {
2017                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
2018                 check_added_monitors!(nodes[0], 1);
2019
2020                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2021                 assert_eq!(events.len(), 1);
2022                 SendEvent::from_event(events.remove(0))
2023         };
2024         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
2025
2026         // channel reserve test with htlc pending output > 0
2027         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2028         {
2029                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
2030                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2031                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2032                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2033         }
2034
2035         // split the rest to test holding cell
2036         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2037         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2038         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2039         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2040         {
2041                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2042                 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);
2043         }
2044
2045         // now see if they go through on both sides
2046         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2047         // but this will stuck in the holding cell
2048         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2049         check_added_monitors!(nodes[0], 0);
2050         let events = nodes[0].node.get_and_clear_pending_events();
2051         assert_eq!(events.len(), 0);
2052
2053         // test with outbound holding cell amount > 0
2054         {
2055                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2056                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2057                         assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)));
2058                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2059                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 2);
2060         }
2061
2062         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2063         // this will also stuck in the holding cell
2064         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2065         check_added_monitors!(nodes[0], 0);
2066         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2067         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2068
2069         // flush the pending htlc
2070         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2071         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2072         check_added_monitors!(nodes[1], 1);
2073
2074         // the pending htlc should be promoted to committed
2075         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2076         check_added_monitors!(nodes[0], 1);
2077         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2078
2079         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2080         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2081         // No commitment_signed so get_event_msg's assert(len == 1) passes
2082         check_added_monitors!(nodes[0], 1);
2083
2084         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2085         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2086         check_added_monitors!(nodes[1], 1);
2087
2088         expect_pending_htlcs_forwardable!(nodes[1]);
2089
2090         let ref payment_event_11 = expect_forward!(nodes[1]);
2091         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2092         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2093
2094         expect_pending_htlcs_forwardable!(nodes[2]);
2095         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2096
2097         // flush the htlcs in the holding cell
2098         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2099         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2100         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2101         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2102         expect_pending_htlcs_forwardable!(nodes[1]);
2103
2104         let ref payment_event_3 = expect_forward!(nodes[1]);
2105         assert_eq!(payment_event_3.msgs.len(), 2);
2106         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2107         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2108
2109         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2110         expect_pending_htlcs_forwardable!(nodes[2]);
2111
2112         let events = nodes[2].node.get_and_clear_pending_events();
2113         assert_eq!(events.len(), 2);
2114         match events[0] {
2115                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2116                         assert_eq!(our_payment_hash_21, *payment_hash);
2117                         assert_eq!(*payment_secret, None);
2118                         assert_eq!(recv_value_21, amt);
2119                 },
2120                 _ => panic!("Unexpected event"),
2121         }
2122         match events[1] {
2123                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2124                         assert_eq!(our_payment_hash_22, *payment_hash);
2125                         assert_eq!(None, *payment_secret);
2126                         assert_eq!(recv_value_22, amt);
2127                 },
2128                 _ => panic!("Unexpected event"),
2129         }
2130
2131         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2132         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2133         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2134
2135         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2136         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2137         {
2138                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_3 + 1);
2139                 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
2140                 match err {
2141                         PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
2142                                 match &fails[0] {
2143                                         &APIError::ChannelUnavailable{ref err} =>
2144                                                 assert!(regex::Regex::new(r"Cannot send value that would put our balance under counterparty-announced channel reserve value \(\d+\)").unwrap().is_match(err)),
2145                                         _ => panic!("Unexpected error variant"),
2146                                 }
2147                         },
2148                         _ => panic!("Unexpected error variant"),
2149                 }
2150                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2151                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put our balance under counterparty-announced channel reserve value".to_string(), 3);
2152         }
2153
2154         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2155
2156         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2157         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);
2158         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2159         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2160         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2161
2162         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2163         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2164 }
2165
2166 #[test]
2167 fn channel_reserve_in_flight_removes() {
2168         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2169         // can send to its counterparty, but due to update ordering, the other side may not yet have
2170         // considered those HTLCs fully removed.
2171         // This tests that we don't count HTLCs which will not be included in the next remote
2172         // commitment transaction towards the reserve value (as it implies no commitment transaction
2173         // will be generated which violates the remote reserve value).
2174         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2175         // To test this we:
2176         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2177         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2178         //    you only consider the value of the first HTLC, it may not),
2179         //  * start routing a third HTLC from A to B,
2180         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2181         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2182         //  * deliver the first fulfill from B
2183         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2184         //    claim,
2185         //  * deliver A's response CS and RAA.
2186         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2187         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2188         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2189         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2190         let chanmon_cfgs = create_chanmon_cfgs(2);
2191         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2192         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2193         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2194         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2195         let logger = test_utils::TestLogger::new();
2196
2197         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2198         // Route the first two HTLCs.
2199         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2200         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2201
2202         // Start routing the third HTLC (this is just used to get everyone in the right state).
2203         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2204         let send_1 = {
2205                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2206                 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();
2207                 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2208                 check_added_monitors!(nodes[0], 1);
2209                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2210                 assert_eq!(events.len(), 1);
2211                 SendEvent::from_event(events.remove(0))
2212         };
2213
2214         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2215         // initial fulfill/CS.
2216         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2217         check_added_monitors!(nodes[1], 1);
2218         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2219
2220         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2221         // remove the second HTLC when we send the HTLC back from B to A.
2222         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2223         check_added_monitors!(nodes[1], 1);
2224         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2225
2226         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2227         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2228         check_added_monitors!(nodes[0], 1);
2229         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2230         expect_payment_sent!(nodes[0], payment_preimage_1);
2231
2232         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2233         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2234         check_added_monitors!(nodes[1], 1);
2235         // B is already AwaitingRAA, so cant generate a CS here
2236         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2237
2238         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2239         check_added_monitors!(nodes[1], 1);
2240         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2241
2242         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2243         check_added_monitors!(nodes[0], 1);
2244         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2245
2246         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2247         check_added_monitors!(nodes[1], 1);
2248         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2249
2250         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2251         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2252         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2253         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2254         // on-chain as necessary).
2255         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2256         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2257         check_added_monitors!(nodes[0], 1);
2258         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2259         expect_payment_sent!(nodes[0], payment_preimage_2);
2260
2261         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2262         check_added_monitors!(nodes[1], 1);
2263         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2264
2265         expect_pending_htlcs_forwardable!(nodes[1]);
2266         expect_payment_received!(nodes[1], payment_hash_3, 100000);
2267
2268         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2269         // resolve the second HTLC from A's point of view.
2270         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2271         check_added_monitors!(nodes[0], 1);
2272         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2273
2274         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2275         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2276         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2277         let send_2 = {
2278                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2279                 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();
2280                 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2281                 check_added_monitors!(nodes[1], 1);
2282                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2283                 assert_eq!(events.len(), 1);
2284                 SendEvent::from_event(events.remove(0))
2285         };
2286
2287         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2288         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2289         check_added_monitors!(nodes[0], 1);
2290         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2291
2292         // Now just resolve all the outstanding messages/HTLCs for completeness...
2293
2294         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2295         check_added_monitors!(nodes[1], 1);
2296         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2297
2298         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2299         check_added_monitors!(nodes[1], 1);
2300
2301         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2302         check_added_monitors!(nodes[0], 1);
2303         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2304
2305         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2306         check_added_monitors!(nodes[1], 1);
2307         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2308
2309         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2310         check_added_monitors!(nodes[0], 1);
2311
2312         expect_pending_htlcs_forwardable!(nodes[0]);
2313         expect_payment_received!(nodes[0], payment_hash_4, 10000);
2314
2315         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2316         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2317 }
2318
2319 #[test]
2320 fn channel_monitor_network_test() {
2321         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2322         // tests that ChannelMonitor is able to recover from various states.
2323         let chanmon_cfgs = create_chanmon_cfgs(5);
2324         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2325         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2326         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2327
2328         // Create some initial channels
2329         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2330         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2331         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2332         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2333
2334         // Rebalance the network a bit by relaying one payment through all the channels...
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         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2338         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2339
2340         // Simple case with no pending HTLCs:
2341         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2342         check_added_monitors!(nodes[1], 1);
2343         {
2344                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2345                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2346                 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2347                 check_added_monitors!(nodes[0], 1);
2348                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2349         }
2350         get_announce_close_broadcast_events(&nodes, 0, 1);
2351         assert_eq!(nodes[0].node.list_channels().len(), 0);
2352         assert_eq!(nodes[1].node.list_channels().len(), 1);
2353
2354         // One pending HTLC is discarded by the force-close:
2355         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2356
2357         // Simple case of one pending HTLC to HTLC-Timeout
2358         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2359         check_added_monitors!(nodes[1], 1);
2360         {
2361                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2362                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2363                 connect_block(&nodes[2], &Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2364                 check_added_monitors!(nodes[2], 1);
2365                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2366         }
2367         get_announce_close_broadcast_events(&nodes, 1, 2);
2368         assert_eq!(nodes[1].node.list_channels().len(), 0);
2369         assert_eq!(nodes[2].node.list_channels().len(), 1);
2370
2371         macro_rules! claim_funds {
2372                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2373                         {
2374                                 assert!($node.node.claim_funds($preimage, &None, $amount));
2375                                 check_added_monitors!($node, 1);
2376
2377                                 let events = $node.node.get_and_clear_pending_msg_events();
2378                                 assert_eq!(events.len(), 1);
2379                                 match events[0] {
2380                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2381                                                 assert!(update_add_htlcs.is_empty());
2382                                                 assert!(update_fail_htlcs.is_empty());
2383                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2384                                         },
2385                                         _ => panic!("Unexpected event"),
2386                                 };
2387                         }
2388                 }
2389         }
2390
2391         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2392         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2393         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2394         check_added_monitors!(nodes[2], 1);
2395         let node2_commitment_txid;
2396         {
2397                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2398                 node2_commitment_txid = node_txn[0].txid();
2399
2400                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2401                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2402
2403                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2404                 connect_block(&nodes[3], &Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2405                 check_added_monitors!(nodes[3], 1);
2406
2407                 check_preimage_claim(&nodes[3], &node_txn);
2408         }
2409         get_announce_close_broadcast_events(&nodes, 2, 3);
2410         assert_eq!(nodes[2].node.list_channels().len(), 0);
2411         assert_eq!(nodes[3].node.list_channels().len(), 1);
2412
2413         { // Cheat and reset nodes[4]'s height to 1
2414                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2415                 connect_block(&nodes[4], &Block { header, txdata: vec![] }, 1);
2416         }
2417
2418         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2419         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2420         // One pending HTLC to time out:
2421         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2422         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2423         // buffer space).
2424
2425         let (close_chan_update_1, close_chan_update_2) = {
2426                 let mut block = Block {
2427                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2428                         txdata: vec![],
2429                 };
2430                 connect_block(&nodes[3], &block, 2);
2431                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2432                         block = Block {
2433                                 header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2434                                 txdata: vec![],
2435                         };
2436                         connect_block(&nodes[3], &block, i);
2437                 }
2438                 let events = nodes[3].node.get_and_clear_pending_msg_events();
2439                 assert_eq!(events.len(), 1);
2440                 let close_chan_update_1 = match events[0] {
2441                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2442                                 msg.clone()
2443                         },
2444                         _ => panic!("Unexpected event"),
2445                 };
2446                 check_added_monitors!(nodes[3], 1);
2447
2448                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2449                 {
2450                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2451                         node_txn.retain(|tx| {
2452                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2453                                         false
2454                                 } else { true }
2455                         });
2456                 }
2457
2458                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2459
2460                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2461                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2462
2463                 block = Block {
2464                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2465                         txdata: vec![],
2466                 };
2467
2468                 connect_block(&nodes[4], &block, 2);
2469                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2470                         block = Block {
2471                                 header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2472                                 txdata: vec![],
2473                         };
2474                         connect_block(&nodes[4], &block, i);
2475                 }
2476                 let events = nodes[4].node.get_and_clear_pending_msg_events();
2477                 assert_eq!(events.len(), 1);
2478                 let close_chan_update_2 = match events[0] {
2479                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2480                                 msg.clone()
2481                         },
2482                         _ => panic!("Unexpected event"),
2483                 };
2484                 check_added_monitors!(nodes[4], 1);
2485                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2486
2487                 block = Block {
2488                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2489                         txdata: vec![node_txn[0].clone()],
2490                 };
2491                 connect_block(&nodes[4], &block, TEST_FINAL_CLTV - 5);
2492
2493                 check_preimage_claim(&nodes[4], &node_txn);
2494                 (close_chan_update_1, close_chan_update_2)
2495         };
2496         nodes[3].net_graph_msg_handler.handle_channel_update(&close_chan_update_2).unwrap();
2497         nodes[4].net_graph_msg_handler.handle_channel_update(&close_chan_update_1).unwrap();
2498         assert_eq!(nodes[3].node.list_channels().len(), 0);
2499         assert_eq!(nodes[4].node.list_channels().len(), 0);
2500 }
2501
2502 #[test]
2503 fn test_justice_tx() {
2504         // Test justice txn built on revoked HTLC-Success tx, against both sides
2505         let mut alice_config = UserConfig::default();
2506         alice_config.channel_options.announced_channel = true;
2507         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2508         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2509         let mut bob_config = UserConfig::default();
2510         bob_config.channel_options.announced_channel = true;
2511         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2512         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2513         let user_cfgs = [Some(alice_config), Some(bob_config)];
2514         let chanmon_cfgs = create_chanmon_cfgs(2);
2515         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2516         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2517         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2518         // Create some new channels:
2519         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2520
2521         // A pending HTLC which will be revoked:
2522         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2523         // Get the will-be-revoked local txn from nodes[0]
2524         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2525         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2526         assert_eq!(revoked_local_txn[0].input.len(), 1);
2527         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2528         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2529         assert_eq!(revoked_local_txn[1].input.len(), 1);
2530         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2531         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2532         // Revoke the old state
2533         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2534
2535         {
2536                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2537                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2538                 {
2539                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2540                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2541                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2542
2543                         check_spends!(node_txn[0], revoked_local_txn[0]);
2544                         node_txn.swap_remove(0);
2545                         node_txn.truncate(1);
2546                 }
2547                 check_added_monitors!(nodes[1], 1);
2548                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2549
2550                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2551                 // Verify broadcast of revoked HTLC-timeout
2552                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2553                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2554                 check_added_monitors!(nodes[0], 1);
2555                 // Broadcast revoked HTLC-timeout on node 1
2556                 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2557                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2558         }
2559         get_announce_close_broadcast_events(&nodes, 0, 1);
2560
2561         assert_eq!(nodes[0].node.list_channels().len(), 0);
2562         assert_eq!(nodes[1].node.list_channels().len(), 0);
2563
2564         // We test justice_tx build by A on B's revoked HTLC-Success tx
2565         // Create some new channels:
2566         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2567         {
2568                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2569                 node_txn.clear();
2570         }
2571
2572         // A pending HTLC which will be revoked:
2573         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2574         // Get the will-be-revoked local txn from B
2575         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2576         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2577         assert_eq!(revoked_local_txn[0].input.len(), 1);
2578         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2579         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2580         // Revoke the old state
2581         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2582         {
2583                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2584                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2585                 {
2586                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2587                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2588                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2589
2590                         check_spends!(node_txn[0], revoked_local_txn[0]);
2591                         node_txn.swap_remove(0);
2592                 }
2593                 check_added_monitors!(nodes[0], 1);
2594                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2595
2596                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2597                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2598                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2599                 check_added_monitors!(nodes[1], 1);
2600                 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2601                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2602         }
2603         get_announce_close_broadcast_events(&nodes, 0, 1);
2604         assert_eq!(nodes[0].node.list_channels().len(), 0);
2605         assert_eq!(nodes[1].node.list_channels().len(), 0);
2606 }
2607
2608 #[test]
2609 fn revoked_output_claim() {
2610         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2611         // transaction is broadcast by its counterparty
2612         let chanmon_cfgs = create_chanmon_cfgs(2);
2613         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2614         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2615         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2616         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2617         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2618         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2619         assert_eq!(revoked_local_txn.len(), 1);
2620         // Only output is the full channel value back to nodes[0]:
2621         assert_eq!(revoked_local_txn[0].output.len(), 1);
2622         // Send a payment through, updating everyone's latest commitment txn
2623         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2624
2625         // Inform nodes[1] that nodes[0] broadcast a stale tx
2626         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2627         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2628         check_added_monitors!(nodes[1], 1);
2629         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2630         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2631
2632         check_spends!(node_txn[0], revoked_local_txn[0]);
2633         check_spends!(node_txn[1], chan_1.3);
2634
2635         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2636         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2637         get_announce_close_broadcast_events(&nodes, 0, 1);
2638         check_added_monitors!(nodes[0], 1)
2639 }
2640
2641 #[test]
2642 fn claim_htlc_outputs_shared_tx() {
2643         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2644         let chanmon_cfgs = create_chanmon_cfgs(2);
2645         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2646         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2647         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2648
2649         // Create some new channel:
2650         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2651
2652         // Rebalance the network to generate htlc in the two directions
2653         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2654         // 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
2655         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2656         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2657
2658         // Get the will-be-revoked local txn from node[0]
2659         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2660         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2661         assert_eq!(revoked_local_txn[0].input.len(), 1);
2662         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2663         assert_eq!(revoked_local_txn[1].input.len(), 1);
2664         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2665         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2666         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2667
2668         //Revoke the old state
2669         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2670
2671         {
2672                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2673                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2674                 check_added_monitors!(nodes[0], 1);
2675                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2676                 check_added_monitors!(nodes[1], 1);
2677                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
2678                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2679
2680                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2681                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2682
2683                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2684                 check_spends!(node_txn[0], revoked_local_txn[0]);
2685
2686                 let mut witness_lens = BTreeSet::new();
2687                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2688                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2689                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2690                 assert_eq!(witness_lens.len(), 3);
2691                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2692                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2693                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2694
2695                 // Next nodes[1] broadcasts its current local tx state:
2696                 assert_eq!(node_txn[1].input.len(), 1);
2697                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2698
2699                 assert_eq!(node_txn[2].input.len(), 1);
2700                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2701                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2702                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2703                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2704                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2705         }
2706         get_announce_close_broadcast_events(&nodes, 0, 1);
2707         assert_eq!(nodes[0].node.list_channels().len(), 0);
2708         assert_eq!(nodes[1].node.list_channels().len(), 0);
2709 }
2710
2711 #[test]
2712 fn claim_htlc_outputs_single_tx() {
2713         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2714         let chanmon_cfgs = create_chanmon_cfgs(2);
2715         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2716         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2717         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2718
2719         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2720
2721         // Rebalance the network to generate htlc in the two directions
2722         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2723         // 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
2724         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2725         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2726         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2727
2728         // Get the will-be-revoked local txn from node[0]
2729         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2730
2731         //Revoke the old state
2732         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2733
2734         {
2735                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2736                 connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2737                 check_added_monitors!(nodes[0], 1);
2738                 connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2739                 check_added_monitors!(nodes[1], 1);
2740                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2741
2742                 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 200, true, header.block_hash());
2743                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2744
2745                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2746                 assert_eq!(node_txn.len(), 9);
2747                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2748                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2749                 // 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)
2750                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2751
2752                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2753                 assert_eq!(node_txn[2].input.len(), 1);
2754                 check_spends!(node_txn[2], chan_1.3);
2755                 assert_eq!(node_txn[3].input.len(), 1);
2756                 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2757                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2758                 check_spends!(node_txn[3], node_txn[2]);
2759
2760                 // Justice transactions are indices 1-2-4
2761                 assert_eq!(node_txn[0].input.len(), 1);
2762                 assert_eq!(node_txn[1].input.len(), 1);
2763                 assert_eq!(node_txn[4].input.len(), 1);
2764
2765                 check_spends!(node_txn[0], revoked_local_txn[0]);
2766                 check_spends!(node_txn[1], revoked_local_txn[0]);
2767                 check_spends!(node_txn[4], revoked_local_txn[0]);
2768
2769                 let mut witness_lens = BTreeSet::new();
2770                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2771                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2772                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2773                 assert_eq!(witness_lens.len(), 3);
2774                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2775                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2776                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2777         }
2778         get_announce_close_broadcast_events(&nodes, 0, 1);
2779         assert_eq!(nodes[0].node.list_channels().len(), 0);
2780         assert_eq!(nodes[1].node.list_channels().len(), 0);
2781 }
2782
2783 #[test]
2784 fn test_htlc_on_chain_success() {
2785         // Test that in case of a unilateral close onchain, we detect the state of output and pass
2786         // the preimage backward accordingly. So here we test that ChannelManager is
2787         // broadcasting the right event to other nodes in payment path.
2788         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2789         // A --------------------> B ----------------------> C (preimage)
2790         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2791         // commitment transaction was broadcast.
2792         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2793         // towards B.
2794         // B should be able to claim via preimage if A then broadcasts its local tx.
2795         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2796         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2797         // PaymentSent event).
2798
2799         let chanmon_cfgs = create_chanmon_cfgs(3);
2800         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2801         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2802         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2803
2804         // Create some initial channels
2805         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2806         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2807
2808         // Rebalance the network a bit by relaying one payment through all the channels...
2809         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2810         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2811
2812         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2813         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2814         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2815
2816         // Broadcast legit commitment tx from C on B's chain
2817         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2818         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2819         assert_eq!(commitment_tx.len(), 1);
2820         check_spends!(commitment_tx[0], chan_2.3);
2821         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2822         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2823         check_added_monitors!(nodes[2], 2);
2824         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2825         assert!(updates.update_add_htlcs.is_empty());
2826         assert!(updates.update_fail_htlcs.is_empty());
2827         assert!(updates.update_fail_malformed_htlcs.is_empty());
2828         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2829
2830         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2831         check_closed_broadcast!(nodes[2], false);
2832         check_added_monitors!(nodes[2], 1);
2833         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)
2834         assert_eq!(node_txn.len(), 5);
2835         assert_eq!(node_txn[0], node_txn[3]);
2836         assert_eq!(node_txn[1], node_txn[4]);
2837         assert_eq!(node_txn[2], commitment_tx[0]);
2838         check_spends!(node_txn[0], commitment_tx[0]);
2839         check_spends!(node_txn[1], commitment_tx[0]);
2840         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2841         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2842         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2843         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2844         assert_eq!(node_txn[0].lock_time, 0);
2845         assert_eq!(node_txn[1].lock_time, 0);
2846
2847         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2848         connect_block(&nodes[1], &Block { header, txdata: node_txn}, 1);
2849         {
2850                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2851                 assert_eq!(added_monitors.len(), 1);
2852                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2853                 added_monitors.clear();
2854         }
2855         let events = nodes[1].node.get_and_clear_pending_msg_events();
2856         {
2857                 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2858                 assert_eq!(added_monitors.len(), 2);
2859                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2860                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2861                 added_monitors.clear();
2862         }
2863         assert_eq!(events.len(), 2);
2864         match events[0] {
2865                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2866                 _ => panic!("Unexpected event"),
2867         }
2868         match events[1] {
2869                 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, .. } } => {
2870                         assert!(update_add_htlcs.is_empty());
2871                         assert!(update_fail_htlcs.is_empty());
2872                         assert_eq!(update_fulfill_htlcs.len(), 1);
2873                         assert!(update_fail_malformed_htlcs.is_empty());
2874                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2875                 },
2876                 _ => panic!("Unexpected event"),
2877         };
2878         macro_rules! check_tx_local_broadcast {
2879                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2880                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2881                         assert_eq!(node_txn.len(), 5);
2882                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2883                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2884                         check_spends!(node_txn[0], $commitment_tx);
2885                         check_spends!(node_txn[1], $commitment_tx);
2886                         assert_ne!(node_txn[0].lock_time, 0);
2887                         assert_ne!(node_txn[1].lock_time, 0);
2888                         if $htlc_offered {
2889                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2890                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2891                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2892                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2893                         } else {
2894                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2895                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2896                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2897                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2898                         }
2899                         check_spends!(node_txn[2], $chan_tx);
2900                         check_spends!(node_txn[3], node_txn[2]);
2901                         check_spends!(node_txn[4], node_txn[2]);
2902                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2903                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2904                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2905                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2906                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2907                         assert_ne!(node_txn[3].lock_time, 0);
2908                         assert_ne!(node_txn[4].lock_time, 0);
2909                         node_txn.clear();
2910                 } }
2911         }
2912         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2913         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2914         // timeout-claim of the output that nodes[2] just claimed via success.
2915         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2916
2917         // Broadcast legit commitment tx from A on B's chain
2918         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2919         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2920         check_spends!(commitment_tx[0], chan_1.3);
2921         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2922         check_closed_broadcast!(nodes[1], false);
2923         check_added_monitors!(nodes[1], 1);
2924         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2925         assert_eq!(node_txn.len(), 4);
2926         check_spends!(node_txn[0], commitment_tx[0]);
2927         assert_eq!(node_txn[0].input.len(), 2);
2928         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2929         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2930         assert_eq!(node_txn[0].lock_time, 0);
2931         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2932         check_spends!(node_txn[1], chan_1.3);
2933         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2934         check_spends!(node_txn[2], node_txn[1]);
2935         check_spends!(node_txn[3], node_txn[1]);
2936         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2937         // we already checked the same situation with A.
2938
2939         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2940         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2941         check_closed_broadcast!(nodes[0], false);
2942         check_added_monitors!(nodes[0], 1);
2943         let events = nodes[0].node.get_and_clear_pending_events();
2944         assert_eq!(events.len(), 2);
2945         let mut first_claimed = false;
2946         for event in events {
2947                 match event {
2948                         Event::PaymentSent { payment_preimage } => {
2949                                 if payment_preimage == our_payment_preimage {
2950                                         assert!(!first_claimed);
2951                                         first_claimed = true;
2952                                 } else {
2953                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2954                                 }
2955                         },
2956                         _ => panic!("Unexpected event"),
2957                 }
2958         }
2959         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2960 }
2961
2962 #[test]
2963 fn test_htlc_on_chain_timeout() {
2964         // Test that in case of a unilateral close onchain, we detect the state of output and
2965         // timeout the HTLC backward accordingly. So here we test that ChannelManager is
2966         // broadcasting the right event to other nodes in payment path.
2967         // A ------------------> B ----------------------> C (timeout)
2968         //    B's commitment tx                 C's commitment tx
2969         //            \                                  \
2970         //         B's HTLC timeout tx               B's timeout tx
2971
2972         let chanmon_cfgs = create_chanmon_cfgs(3);
2973         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2974         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2975         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2976
2977         // Create some intial channels
2978         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2979         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2980
2981         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2982         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2983         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2984
2985         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2986         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2987
2988         // Broadcast legit commitment tx from C on B's chain
2989         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2990         check_spends!(commitment_tx[0], chan_2.3);
2991         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2992         check_added_monitors!(nodes[2], 0);
2993         expect_pending_htlcs_forwardable!(nodes[2]);
2994         check_added_monitors!(nodes[2], 1);
2995
2996         let events = nodes[2].node.get_and_clear_pending_msg_events();
2997         assert_eq!(events.len(), 1);
2998         match events[0] {
2999                 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, .. } } => {
3000                         assert!(update_add_htlcs.is_empty());
3001                         assert!(!update_fail_htlcs.is_empty());
3002                         assert!(update_fulfill_htlcs.is_empty());
3003                         assert!(update_fail_malformed_htlcs.is_empty());
3004                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
3005                 },
3006                 _ => panic!("Unexpected event"),
3007         };
3008         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
3009         check_closed_broadcast!(nodes[2], false);
3010         check_added_monitors!(nodes[2], 1);
3011         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
3012         assert_eq!(node_txn.len(), 1);
3013         check_spends!(node_txn[0], chan_2.3);
3014         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
3015
3016         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
3017         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
3018         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3019         let timeout_tx;
3020         {
3021                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3022                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
3023                 assert_eq!(node_txn[1], node_txn[3]);
3024                 assert_eq!(node_txn[2], node_txn[4]);
3025
3026                 check_spends!(node_txn[0], commitment_tx[0]);
3027                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3028
3029                 check_spends!(node_txn[1], chan_2.3);
3030                 check_spends!(node_txn[2], node_txn[1]);
3031                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3032                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3033
3034                 timeout_tx = node_txn[0].clone();
3035                 node_txn.clear();
3036         }
3037
3038         connect_block(&nodes[1], &Block { header, txdata: vec![timeout_tx]}, 1);
3039         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
3040         check_added_monitors!(nodes[1], 1);
3041         check_closed_broadcast!(nodes[1], false);
3042
3043         expect_pending_htlcs_forwardable!(nodes[1]);
3044         check_added_monitors!(nodes[1], 1);
3045         let events = nodes[1].node.get_and_clear_pending_msg_events();
3046         assert_eq!(events.len(), 1);
3047         match events[0] {
3048                 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, .. } } => {
3049                         assert!(update_add_htlcs.is_empty());
3050                         assert!(!update_fail_htlcs.is_empty());
3051                         assert!(update_fulfill_htlcs.is_empty());
3052                         assert!(update_fail_malformed_htlcs.is_empty());
3053                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3054                 },
3055                 _ => panic!("Unexpected event"),
3056         };
3057         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
3058         assert_eq!(node_txn.len(), 0);
3059
3060         // Broadcast legit commitment tx from B on A's chain
3061         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3062         check_spends!(commitment_tx[0], chan_1.3);
3063
3064         connect_block(&nodes[0], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3065         check_closed_broadcast!(nodes[0], false);
3066         check_added_monitors!(nodes[0], 1);
3067         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3068         assert_eq!(node_txn.len(), 3);
3069         check_spends!(node_txn[0], commitment_tx[0]);
3070         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3071         check_spends!(node_txn[1], chan_1.3);
3072         check_spends!(node_txn[2], node_txn[1]);
3073         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3074         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3075 }
3076
3077 #[test]
3078 fn test_simple_commitment_revoked_fail_backward() {
3079         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3080         // and fail backward accordingly.
3081
3082         let chanmon_cfgs = create_chanmon_cfgs(3);
3083         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3084         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3085         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3086
3087         // Create some initial channels
3088         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3089         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3090
3091         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3092         // Get the will-be-revoked local txn from nodes[2]
3093         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3094         // Revoke the old state
3095         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3096
3097         let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3098
3099         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3100         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3101         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
3102         check_added_monitors!(nodes[1], 1);
3103         check_closed_broadcast!(nodes[1], false);
3104
3105         expect_pending_htlcs_forwardable!(nodes[1]);
3106         check_added_monitors!(nodes[1], 1);
3107         let events = nodes[1].node.get_and_clear_pending_msg_events();
3108         assert_eq!(events.len(), 1);
3109         match events[0] {
3110                 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, .. } } => {
3111                         assert!(update_add_htlcs.is_empty());
3112                         assert_eq!(update_fail_htlcs.len(), 1);
3113                         assert!(update_fulfill_htlcs.is_empty());
3114                         assert!(update_fail_malformed_htlcs.is_empty());
3115                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3116
3117                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3118                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3119
3120                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3121                         assert_eq!(events.len(), 1);
3122                         match events[0] {
3123                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3124                                 _ => panic!("Unexpected event"),
3125                         }
3126                         expect_payment_failed!(nodes[0], payment_hash, false);
3127                 },
3128                 _ => panic!("Unexpected event"),
3129         }
3130 }
3131
3132 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3133         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3134         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3135         // commitment transaction anymore.
3136         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3137         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3138         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3139         // technically disallowed and we should probably handle it reasonably.
3140         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3141         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3142         // transactions:
3143         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3144         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3145         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3146         //   and once they revoke the previous commitment transaction (allowing us to send a new
3147         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3148         let chanmon_cfgs = create_chanmon_cfgs(3);
3149         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3150         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3151         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3152
3153         // Create some initial channels
3154         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3155         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3156
3157         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3158         // Get the will-be-revoked local txn from nodes[2]
3159         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3160         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3161         // Revoke the old state
3162         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3163
3164         let value = if use_dust {
3165                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3166                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3167                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().holder_dust_limit_satoshis * 1000
3168         } else { 3000000 };
3169
3170         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3171         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3172         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3173
3174         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3175         expect_pending_htlcs_forwardable!(nodes[2]);
3176         check_added_monitors!(nodes[2], 1);
3177         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3178         assert!(updates.update_add_htlcs.is_empty());
3179         assert!(updates.update_fulfill_htlcs.is_empty());
3180         assert!(updates.update_fail_malformed_htlcs.is_empty());
3181         assert_eq!(updates.update_fail_htlcs.len(), 1);
3182         assert!(updates.update_fee.is_none());
3183         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3184         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3185         // Drop the last RAA from 3 -> 2
3186
3187         assert!(nodes[2].node.fail_htlc_backwards(&second_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         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3198         check_added_monitors!(nodes[1], 1);
3199         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3200         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3201         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3202         check_added_monitors!(nodes[2], 1);
3203
3204         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3205         expect_pending_htlcs_forwardable!(nodes[2]);
3206         check_added_monitors!(nodes[2], 1);
3207         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3208         assert!(updates.update_add_htlcs.is_empty());
3209         assert!(updates.update_fulfill_htlcs.is_empty());
3210         assert!(updates.update_fail_malformed_htlcs.is_empty());
3211         assert_eq!(updates.update_fail_htlcs.len(), 1);
3212         assert!(updates.update_fee.is_none());
3213         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3214         // At this point first_payment_hash has dropped out of the latest two commitment
3215         // transactions that nodes[1] is tracking...
3216         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3217         check_added_monitors!(nodes[1], 1);
3218         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3219         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3220         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3221         check_added_monitors!(nodes[2], 1);
3222
3223         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3224         // on nodes[2]'s RAA.
3225         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3226         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3227         let logger = test_utils::TestLogger::new();
3228         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();
3229         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3230         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3231         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3232         check_added_monitors!(nodes[1], 0);
3233
3234         if deliver_bs_raa {
3235                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3236                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3237                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3238                 check_added_monitors!(nodes[1], 1);
3239                 let events = nodes[1].node.get_and_clear_pending_events();
3240                 assert_eq!(events.len(), 1);
3241                 match events[0] {
3242                         Event::PendingHTLCsForwardable { .. } => { },
3243                         _ => panic!("Unexpected event"),
3244                 };
3245                 // Deliberately don't process the pending fail-back so they all fail back at once after
3246                 // block connection just like the !deliver_bs_raa case
3247         }
3248
3249         let mut failed_htlcs = HashSet::new();
3250         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3251
3252         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3253         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3254         check_added_monitors!(nodes[1], 1);
3255         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
3256
3257         let events = nodes[1].node.get_and_clear_pending_events();
3258         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3259         match events[0] {
3260                 Event::PaymentFailed { ref payment_hash, .. } => {
3261                         assert_eq!(*payment_hash, fourth_payment_hash);
3262                 },
3263                 _ => panic!("Unexpected event"),
3264         }
3265         if !deliver_bs_raa {
3266                 match events[1] {
3267                         Event::PendingHTLCsForwardable { .. } => { },
3268                         _ => panic!("Unexpected event"),
3269                 };
3270         }
3271         nodes[1].node.process_pending_htlc_forwards();
3272         check_added_monitors!(nodes[1], 1);
3273
3274         let events = nodes[1].node.get_and_clear_pending_msg_events();
3275         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3276         match events[if deliver_bs_raa { 1 } else { 0 }] {
3277                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3278                 _ => panic!("Unexpected event"),
3279         }
3280         if deliver_bs_raa {
3281                 match events[0] {
3282                         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, .. } } => {
3283                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3284                                 assert_eq!(update_add_htlcs.len(), 1);
3285                                 assert!(update_fulfill_htlcs.is_empty());
3286                                 assert!(update_fail_htlcs.is_empty());
3287                                 assert!(update_fail_malformed_htlcs.is_empty());
3288                         },
3289                         _ => panic!("Unexpected event"),
3290                 }
3291         }
3292         match events[if deliver_bs_raa { 2 } else { 1 }] {
3293                 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, .. } } => {
3294                         assert!(update_add_htlcs.is_empty());
3295                         assert_eq!(update_fail_htlcs.len(), 3);
3296                         assert!(update_fulfill_htlcs.is_empty());
3297                         assert!(update_fail_malformed_htlcs.is_empty());
3298                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3299
3300                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3301                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3302                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3303
3304                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3305
3306                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3307                         // If we delivered B's RAA we got an unknown preimage error, not something
3308                         // that we should update our routing table for.
3309                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3310                         for event in events {
3311                                 match event {
3312                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3313                                         _ => panic!("Unexpected event"),
3314                                 }
3315                         }
3316                         let events = nodes[0].node.get_and_clear_pending_events();
3317                         assert_eq!(events.len(), 3);
3318                         match events[0] {
3319                                 Event::PaymentFailed { ref payment_hash, .. } => {
3320                                         assert!(failed_htlcs.insert(payment_hash.0));
3321                                 },
3322                                 _ => panic!("Unexpected event"),
3323                         }
3324                         match events[1] {
3325                                 Event::PaymentFailed { ref payment_hash, .. } => {
3326                                         assert!(failed_htlcs.insert(payment_hash.0));
3327                                 },
3328                                 _ => panic!("Unexpected event"),
3329                         }
3330                         match events[2] {
3331                                 Event::PaymentFailed { ref payment_hash, .. } => {
3332                                         assert!(failed_htlcs.insert(payment_hash.0));
3333                                 },
3334                                 _ => panic!("Unexpected event"),
3335                         }
3336                 },
3337                 _ => panic!("Unexpected event"),
3338         }
3339
3340         assert!(failed_htlcs.contains(&first_payment_hash.0));
3341         assert!(failed_htlcs.contains(&second_payment_hash.0));
3342         assert!(failed_htlcs.contains(&third_payment_hash.0));
3343 }
3344
3345 #[test]
3346 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3347         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3348         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3349         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3350         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3351 }
3352
3353 #[test]
3354 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3355         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3356         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3357         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3358         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3359 }
3360
3361 #[test]
3362 fn fail_backward_pending_htlc_upon_channel_failure() {
3363         let chanmon_cfgs = create_chanmon_cfgs(2);
3364         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3365         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3366         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3367         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3368         let logger = test_utils::TestLogger::new();
3369
3370         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3371         {
3372                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
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, payment_hash, &None).unwrap();
3376                 check_added_monitors!(nodes[0], 1);
3377
3378                 let payment_event = {
3379                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3380                         assert_eq!(events.len(), 1);
3381                         SendEvent::from_event(events.remove(0))
3382                 };
3383                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3384                 assert_eq!(payment_event.msgs.len(), 1);
3385         }
3386
3387         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3388         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3389         {
3390                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3391                 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();
3392                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3393                 check_added_monitors!(nodes[0], 0);
3394
3395                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3396         }
3397
3398         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3399         {
3400                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3401
3402                 let secp_ctx = Secp256k1::new();
3403                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3404                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3405                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3406                 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();
3407                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3408                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3409                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3410
3411                 // Send a 0-msat update_add_htlc to fail the channel.
3412                 let update_add_htlc = msgs::UpdateAddHTLC {
3413                         channel_id: chan.2,
3414                         htlc_id: 0,
3415                         amount_msat: 0,
3416                         payment_hash,
3417                         cltv_expiry,
3418                         onion_routing_packet,
3419                 };
3420                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3421         }
3422
3423         // Check that Alice fails backward the pending HTLC from the second payment.
3424         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3425         check_closed_broadcast!(nodes[0], true);
3426         check_added_monitors!(nodes[0], 1);
3427 }
3428
3429 #[test]
3430 fn test_htlc_ignore_latest_remote_commitment() {
3431         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3432         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3433         let chanmon_cfgs = create_chanmon_cfgs(2);
3434         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3435         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3436         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3437         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3438
3439         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3440         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3441         check_closed_broadcast!(nodes[0], false);
3442         check_added_monitors!(nodes[0], 1);
3443
3444         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3445         assert_eq!(node_txn.len(), 2);
3446
3447         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3448         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3449         check_closed_broadcast!(nodes[1], false);
3450         check_added_monitors!(nodes[1], 1);
3451
3452         // Duplicate the connect_block call since this may happen due to other listeners
3453         // registering new transactions
3454         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3455 }
3456
3457 #[test]
3458 fn test_force_close_fail_back() {
3459         // Check which HTLCs are failed-backwards on channel force-closure
3460         let chanmon_cfgs = create_chanmon_cfgs(3);
3461         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3462         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3463         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3464         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3465         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3466         let logger = test_utils::TestLogger::new();
3467
3468         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3469
3470         let mut payment_event = {
3471                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3472                 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();
3473                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3474                 check_added_monitors!(nodes[0], 1);
3475
3476                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3477                 assert_eq!(events.len(), 1);
3478                 SendEvent::from_event(events.remove(0))
3479         };
3480
3481         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3482         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3483
3484         expect_pending_htlcs_forwardable!(nodes[1]);
3485
3486         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3487         assert_eq!(events_2.len(), 1);
3488         payment_event = SendEvent::from_event(events_2.remove(0));
3489         assert_eq!(payment_event.msgs.len(), 1);
3490
3491         check_added_monitors!(nodes[1], 1);
3492         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3493         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3494         check_added_monitors!(nodes[2], 1);
3495         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3496
3497         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3498         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3499         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3500
3501         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3502         check_closed_broadcast!(nodes[2], false);
3503         check_added_monitors!(nodes[2], 1);
3504         let tx = {
3505                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3506                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3507                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3508                 // back to nodes[1] upon timeout otherwise.
3509                 assert_eq!(node_txn.len(), 1);
3510                 node_txn.remove(0)
3511         };
3512
3513         let block = Block {
3514                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3515                 txdata: vec![tx.clone()],
3516         };
3517         connect_block(&nodes[1], &block, 1);
3518
3519         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3520         check_closed_broadcast!(nodes[1], false);
3521         check_added_monitors!(nodes[1], 1);
3522
3523         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3524         {
3525                 let mut monitors = nodes[2].chain_monitor.chain_monitor.monitors.lock().unwrap();
3526                 monitors.get_mut(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3527                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3528         }
3529         connect_block(&nodes[2], &block, 1);
3530         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3531         assert_eq!(node_txn.len(), 1);
3532         assert_eq!(node_txn[0].input.len(), 1);
3533         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3534         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3535         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3536
3537         check_spends!(node_txn[0], tx);
3538 }
3539
3540 #[test]
3541 fn test_unconf_chan() {
3542         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3543         let chanmon_cfgs = create_chanmon_cfgs(2);
3544         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3545         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3546         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3547         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3548
3549         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3550         assert_eq!(channel_state.by_id.len(), 1);
3551         assert_eq!(channel_state.short_to_id.len(), 1);
3552         mem::drop(channel_state);
3553
3554         let mut headers = Vec::new();
3555         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3556         headers.push(header.clone());
3557         for _i in 2..100 {
3558                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3559                 headers.push(header.clone());
3560         }
3561         let mut height = 99;
3562         while !headers.is_empty() {
3563                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3564                 height -= 1;
3565         }
3566         check_closed_broadcast!(nodes[0], false);
3567         check_added_monitors!(nodes[0], 1);
3568         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3569         assert_eq!(channel_state.by_id.len(), 0);
3570         assert_eq!(channel_state.short_to_id.len(), 0);
3571 }
3572
3573 #[test]
3574 fn test_simple_peer_disconnect() {
3575         // Test that we can reconnect when there are no lost messages
3576         let chanmon_cfgs = create_chanmon_cfgs(3);
3577         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3578         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3579         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3580         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3581         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3582
3583         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3584         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3585         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3586
3587         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3588         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3589         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3590         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3591
3592         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3593         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3594         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3595
3596         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3597         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3598         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3599         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3600
3601         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3602         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3603
3604         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3605         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3606
3607         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3608         {
3609                 let events = nodes[0].node.get_and_clear_pending_events();
3610                 assert_eq!(events.len(), 2);
3611                 match events[0] {
3612                         Event::PaymentSent { payment_preimage } => {
3613                                 assert_eq!(payment_preimage, payment_preimage_3);
3614                         },
3615                         _ => panic!("Unexpected event"),
3616                 }
3617                 match events[1] {
3618                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3619                                 assert_eq!(payment_hash, payment_hash_5);
3620                                 assert!(rejected_by_dest);
3621                         },
3622                         _ => panic!("Unexpected event"),
3623                 }
3624         }
3625
3626         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3627         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3628 }
3629
3630 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3631         // Test that we can reconnect when in-flight HTLC updates get dropped
3632         let chanmon_cfgs = create_chanmon_cfgs(2);
3633         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3634         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3635         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3636         if messages_delivered == 0 {
3637                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3638                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3639         } else {
3640                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3641         }
3642
3643         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3644
3645         let logger = test_utils::TestLogger::new();
3646         let payment_event = {
3647                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3648                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3649                         &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3650                         &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3651                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3652                 check_added_monitors!(nodes[0], 1);
3653
3654                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3655                 assert_eq!(events.len(), 1);
3656                 SendEvent::from_event(events.remove(0))
3657         };
3658         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3659
3660         if messages_delivered < 2 {
3661                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3662         } else {
3663                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3664                 if messages_delivered >= 3 {
3665                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3666                         check_added_monitors!(nodes[1], 1);
3667                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3668
3669                         if messages_delivered >= 4 {
3670                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3671                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3672                                 check_added_monitors!(nodes[0], 1);
3673
3674                                 if messages_delivered >= 5 {
3675                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3676                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3677                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3678                                         check_added_monitors!(nodes[0], 1);
3679
3680                                         if messages_delivered >= 6 {
3681                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3682                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3683                                                 check_added_monitors!(nodes[1], 1);
3684                                         }
3685                                 }
3686                         }
3687                 }
3688         }
3689
3690         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3691         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3692         if messages_delivered < 3 {
3693                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3694                 // received on either side, both sides will need to resend them.
3695                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3696         } else if messages_delivered == 3 {
3697                 // nodes[0] still wants its RAA + commitment_signed
3698                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3699         } else if messages_delivered == 4 {
3700                 // nodes[0] still wants its commitment_signed
3701                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3702         } else if messages_delivered == 5 {
3703                 // nodes[1] still wants its final RAA
3704                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3705         } else if messages_delivered == 6 {
3706                 // Everything was delivered...
3707                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3708         }
3709
3710         let events_1 = nodes[1].node.get_and_clear_pending_events();
3711         assert_eq!(events_1.len(), 1);
3712         match events_1[0] {
3713                 Event::PendingHTLCsForwardable { .. } => { },
3714                 _ => panic!("Unexpected event"),
3715         };
3716
3717         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3718         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3719         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3720
3721         nodes[1].node.process_pending_htlc_forwards();
3722
3723         let events_2 = nodes[1].node.get_and_clear_pending_events();
3724         assert_eq!(events_2.len(), 1);
3725         match events_2[0] {
3726                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3727                         assert_eq!(payment_hash_1, *payment_hash);
3728                         assert_eq!(*payment_secret, None);
3729                         assert_eq!(amt, 1000000);
3730                 },
3731                 _ => panic!("Unexpected event"),
3732         }
3733
3734         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3735         check_added_monitors!(nodes[1], 1);
3736
3737         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3738         assert_eq!(events_3.len(), 1);
3739         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3740                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3741                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3742                         assert!(updates.update_add_htlcs.is_empty());
3743                         assert!(updates.update_fail_htlcs.is_empty());
3744                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3745                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3746                         assert!(updates.update_fee.is_none());
3747                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3748                 },
3749                 _ => panic!("Unexpected event"),
3750         };
3751
3752         if messages_delivered >= 1 {
3753                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3754
3755                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3756                 assert_eq!(events_4.len(), 1);
3757                 match events_4[0] {
3758                         Event::PaymentSent { ref payment_preimage } => {
3759                                 assert_eq!(payment_preimage_1, *payment_preimage);
3760                         },
3761                         _ => panic!("Unexpected event"),
3762                 }
3763
3764                 if messages_delivered >= 2 {
3765                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3766                         check_added_monitors!(nodes[0], 1);
3767                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3768
3769                         if messages_delivered >= 3 {
3770                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3771                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3772                                 check_added_monitors!(nodes[1], 1);
3773
3774                                 if messages_delivered >= 4 {
3775                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3776                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3777                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3778                                         check_added_monitors!(nodes[1], 1);
3779
3780                                         if messages_delivered >= 5 {
3781                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3782                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3783                                                 check_added_monitors!(nodes[0], 1);
3784                                         }
3785                                 }
3786                         }
3787                 }
3788         }
3789
3790         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3791         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3792         if messages_delivered < 2 {
3793                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3794                 //TODO: Deduplicate PaymentSent events, then enable this if:
3795                 //if messages_delivered < 1 {
3796                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3797                         assert_eq!(events_4.len(), 1);
3798                         match events_4[0] {
3799                                 Event::PaymentSent { ref payment_preimage } => {
3800                                         assert_eq!(payment_preimage_1, *payment_preimage);
3801                                 },
3802                                 _ => panic!("Unexpected event"),
3803                         }
3804                 //}
3805         } else if messages_delivered == 2 {
3806                 // nodes[0] still wants its RAA + commitment_signed
3807                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3808         } else if messages_delivered == 3 {
3809                 // nodes[0] still wants its commitment_signed
3810                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3811         } else if messages_delivered == 4 {
3812                 // nodes[1] still wants its final RAA
3813                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3814         } else if messages_delivered == 5 {
3815                 // Everything was delivered...
3816                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3817         }
3818
3819         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3820         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3821         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3822
3823         // Channel should still work fine...
3824         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3825         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
3826                 &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
3827                 &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3828         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3829         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3830 }
3831
3832 #[test]
3833 fn test_drop_messages_peer_disconnect_a() {
3834         do_test_drop_messages_peer_disconnect(0);
3835         do_test_drop_messages_peer_disconnect(1);
3836         do_test_drop_messages_peer_disconnect(2);
3837         do_test_drop_messages_peer_disconnect(3);
3838 }
3839
3840 #[test]
3841 fn test_drop_messages_peer_disconnect_b() {
3842         do_test_drop_messages_peer_disconnect(4);
3843         do_test_drop_messages_peer_disconnect(5);
3844         do_test_drop_messages_peer_disconnect(6);
3845 }
3846
3847 #[test]
3848 fn test_funding_peer_disconnect() {
3849         // Test that we can lock in our funding tx while disconnected
3850         let chanmon_cfgs = create_chanmon_cfgs(2);
3851         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3852         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3853         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3854         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3855
3856         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3857         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3858
3859         confirm_transaction(&nodes[0], &tx);
3860         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3861         assert_eq!(events_1.len(), 1);
3862         match events_1[0] {
3863                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3864                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3865                 },
3866                 _ => panic!("Unexpected event"),
3867         }
3868
3869         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3870
3871         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3872         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3873
3874         confirm_transaction(&nodes[1], &tx);
3875         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3876         assert_eq!(events_2.len(), 2);
3877         let funding_locked = match events_2[0] {
3878                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3879                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3880                         msg.clone()
3881                 },
3882                 _ => panic!("Unexpected event"),
3883         };
3884         let bs_announcement_sigs = match events_2[1] {
3885                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3886                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3887                         msg.clone()
3888                 },
3889                 _ => panic!("Unexpected event"),
3890         };
3891
3892         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3893
3894         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3895         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3896         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3897         assert_eq!(events_3.len(), 2);
3898         let as_announcement_sigs = match events_3[0] {
3899                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3900                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3901                         msg.clone()
3902                 },
3903                 _ => panic!("Unexpected event"),
3904         };
3905         let (as_announcement, as_update) = match events_3[1] {
3906                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3907                         (msg.clone(), update_msg.clone())
3908                 },
3909                 _ => panic!("Unexpected event"),
3910         };
3911
3912         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3913         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3914         assert_eq!(events_4.len(), 1);
3915         let (_, bs_update) = match events_4[0] {
3916                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3917                         (msg.clone(), update_msg.clone())
3918                 },
3919                 _ => panic!("Unexpected event"),
3920         };
3921
3922         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3923         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3924         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3925
3926         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3927         let logger = test_utils::TestLogger::new();
3928         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();
3929         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3930         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3931 }
3932
3933 #[test]
3934 fn test_drop_messages_peer_disconnect_dual_htlc() {
3935         // Test that we can handle reconnecting when both sides of a channel have pending
3936         // commitment_updates when we disconnect.
3937         let chanmon_cfgs = create_chanmon_cfgs(2);
3938         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3939         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3940         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3941         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3942         let logger = test_utils::TestLogger::new();
3943
3944         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3945
3946         // Now try to send a second payment which will fail to send
3947         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3948         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3949         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();
3950         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3951         check_added_monitors!(nodes[0], 1);
3952
3953         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3954         assert_eq!(events_1.len(), 1);
3955         match events_1[0] {
3956                 MessageSendEvent::UpdateHTLCs { .. } => {},
3957                 _ => panic!("Unexpected event"),
3958         }
3959
3960         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3961         check_added_monitors!(nodes[1], 1);
3962
3963         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3964         assert_eq!(events_2.len(), 1);
3965         match events_2[0] {
3966                 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 } } => {
3967                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3968                         assert!(update_add_htlcs.is_empty());
3969                         assert_eq!(update_fulfill_htlcs.len(), 1);
3970                         assert!(update_fail_htlcs.is_empty());
3971                         assert!(update_fail_malformed_htlcs.is_empty());
3972                         assert!(update_fee.is_none());
3973
3974                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3975                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3976                         assert_eq!(events_3.len(), 1);
3977                         match events_3[0] {
3978                                 Event::PaymentSent { ref payment_preimage } => {
3979                                         assert_eq!(*payment_preimage, payment_preimage_1);
3980                                 },
3981                                 _ => panic!("Unexpected event"),
3982                         }
3983
3984                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3985                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3986                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3987                         check_added_monitors!(nodes[0], 1);
3988                 },
3989                 _ => panic!("Unexpected event"),
3990         }
3991
3992         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3993         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3994
3995         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3996         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3997         assert_eq!(reestablish_1.len(), 1);
3998         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3999         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4000         assert_eq!(reestablish_2.len(), 1);
4001
4002         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4003         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
4004         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4005         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
4006
4007         assert!(as_resp.0.is_none());
4008         assert!(bs_resp.0.is_none());
4009
4010         assert!(bs_resp.1.is_none());
4011         assert!(bs_resp.2.is_none());
4012
4013         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
4014
4015         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
4016         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
4017         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
4018         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
4019         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
4020         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
4021         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
4022         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4023         // No commitment_signed so get_event_msg's assert(len == 1) passes
4024         check_added_monitors!(nodes[1], 1);
4025
4026         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
4027         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4028         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
4029         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
4030         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
4031         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
4032         assert!(bs_second_commitment_signed.update_fee.is_none());
4033         check_added_monitors!(nodes[1], 1);
4034
4035         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
4036         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4037         assert!(as_commitment_signed.update_add_htlcs.is_empty());
4038         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
4039         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
4040         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
4041         assert!(as_commitment_signed.update_fee.is_none());
4042         check_added_monitors!(nodes[0], 1);
4043
4044         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
4045         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4046         // No commitment_signed so get_event_msg's assert(len == 1) passes
4047         check_added_monitors!(nodes[0], 1);
4048
4049         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4050         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4051         // No commitment_signed so get_event_msg's assert(len == 1) passes
4052         check_added_monitors!(nodes[1], 1);
4053
4054         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4055         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4056         check_added_monitors!(nodes[1], 1);
4057
4058         expect_pending_htlcs_forwardable!(nodes[1]);
4059
4060         let events_5 = nodes[1].node.get_and_clear_pending_events();
4061         assert_eq!(events_5.len(), 1);
4062         match events_5[0] {
4063                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
4064                         assert_eq!(payment_hash_2, *payment_hash);
4065                         assert_eq!(*payment_secret, None);
4066                 },
4067                 _ => panic!("Unexpected event"),
4068         }
4069
4070         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4071         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4072         check_added_monitors!(nodes[0], 1);
4073
4074         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
4075 }
4076
4077 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4078         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4079         // to avoid our counterparty failing the channel.
4080         let chanmon_cfgs = create_chanmon_cfgs(2);
4081         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4082         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4083         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4084
4085         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4086         let logger = test_utils::TestLogger::new();
4087
4088         let our_payment_hash = if send_partial_mpp {
4089                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4090                 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();
4091                 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4092                 let payment_secret = PaymentSecret([0xdb; 32]);
4093                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4094                 // indicates there are more HTLCs coming.
4095                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, CHAN_CONFIRM_DEPTH).unwrap();
4096                 check_added_monitors!(nodes[0], 1);
4097                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4098                 assert_eq!(events.len(), 1);
4099                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4100                 // hop should *not* yet generate any PaymentReceived event(s).
4101                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4102                 our_payment_hash
4103         } else {
4104                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4105         };
4106
4107         let mut block = Block {
4108                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4109                 txdata: vec![],
4110         };
4111         connect_block(&nodes[0], &block, 101);
4112         connect_block(&nodes[1], &block, 101);
4113         for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4114                 block.header.prev_blockhash = block.block_hash();
4115                 connect_block(&nodes[0], &block, i);
4116                 connect_block(&nodes[1], &block, i);
4117         }
4118
4119         expect_pending_htlcs_forwardable!(nodes[1]);
4120
4121         check_added_monitors!(nodes[1], 1);
4122         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4123         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4124         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4125         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4126         assert!(htlc_timeout_updates.update_fee.is_none());
4127
4128         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4129         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4130         // 100_000 msat as u64, followed by a height of 123 as u32
4131         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4132         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(123));
4133         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4134 }
4135
4136 #[test]
4137 fn test_htlc_timeout() {
4138         do_test_htlc_timeout(true);
4139         do_test_htlc_timeout(false);
4140 }
4141
4142 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4143         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4144         let chanmon_cfgs = create_chanmon_cfgs(3);
4145         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4146         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4147         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4148         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4149         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4150         let logger = test_utils::TestLogger::new();
4151
4152         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4153         let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4154         {
4155                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4156                 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();
4157                 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4158         }
4159         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4160         check_added_monitors!(nodes[1], 1);
4161
4162         // Now attempt to route a second payment, which should be placed in the holding cell
4163         let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4164         if forwarded_htlc {
4165                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4166                 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();
4167                 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4168                 check_added_monitors!(nodes[0], 1);
4169                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4170                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4171                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4172                 expect_pending_htlcs_forwardable!(nodes[1]);
4173                 check_added_monitors!(nodes[1], 0);
4174         } else {
4175                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4176                 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();
4177                 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4178                 check_added_monitors!(nodes[1], 0);
4179         }
4180
4181         let mut block = Block {
4182                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4183                 txdata: vec![],
4184         };
4185         connect_block(&nodes[1], &block, 101);
4186         for i in 102..TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4187                 block.header.prev_blockhash = block.block_hash();
4188                 connect_block(&nodes[1], &block, i);
4189         }
4190
4191         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4192         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4193
4194         block.header.prev_blockhash = block.block_hash();
4195         connect_block(&nodes[1], &block, TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4196
4197         if forwarded_htlc {
4198                 expect_pending_htlcs_forwardable!(nodes[1]);
4199                 check_added_monitors!(nodes[1], 1);
4200                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4201                 assert_eq!(fail_commit.len(), 1);
4202                 match fail_commit[0] {
4203                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4204                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4205                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4206                         },
4207                         _ => unreachable!(),
4208                 }
4209                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4210                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4211                         match update {
4212                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4213                                 _ => panic!("Unexpected event"),
4214                         }
4215                 } else {
4216                         panic!("Unexpected event");
4217                 }
4218         } else {
4219                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4220         }
4221 }
4222
4223 #[test]
4224 fn test_holding_cell_htlc_add_timeouts() {
4225         do_test_holding_cell_htlc_add_timeouts(false);
4226         do_test_holding_cell_htlc_add_timeouts(true);
4227 }
4228
4229 #[test]
4230 fn test_invalid_channel_announcement() {
4231         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4232         let secp_ctx = Secp256k1::new();
4233         let chanmon_cfgs = create_chanmon_cfgs(2);
4234         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4235         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4236         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4237
4238         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4239
4240         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4241         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4242         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4243         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4244
4245         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 } );
4246
4247         let as_bitcoin_key = as_chan.get_keys().inner.holder_channel_pubkeys.funding_pubkey;
4248         let bs_bitcoin_key = bs_chan.get_keys().inner.holder_channel_pubkeys.funding_pubkey;
4249
4250         let as_network_key = nodes[0].node.get_our_node_id();
4251         let bs_network_key = nodes[1].node.get_our_node_id();
4252
4253         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4254
4255         let mut chan_announcement;
4256
4257         macro_rules! dummy_unsigned_msg {
4258                 () => {
4259                         msgs::UnsignedChannelAnnouncement {
4260                                 features: ChannelFeatures::known(),
4261                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
4262                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4263                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4264                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4265                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4266                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4267                                 excess_data: Vec::new(),
4268                         };
4269                 }
4270         }
4271
4272         macro_rules! sign_msg {
4273                 ($unsigned_msg: expr) => {
4274                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4275                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_keys().inner.funding_key);
4276                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_keys().inner.funding_key);
4277                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4278                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4279                         chan_announcement = msgs::ChannelAnnouncement {
4280                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4281                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4282                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4283                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4284                                 contents: $unsigned_msg
4285                         }
4286                 }
4287         }
4288
4289         let unsigned_msg = dummy_unsigned_msg!();
4290         sign_msg!(unsigned_msg);
4291         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4292         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 } );
4293
4294         // Configured with Network::Testnet
4295         let mut unsigned_msg = dummy_unsigned_msg!();
4296         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.block_hash();
4297         sign_msg!(unsigned_msg);
4298         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4299
4300         let mut unsigned_msg = dummy_unsigned_msg!();
4301         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4302         sign_msg!(unsigned_msg);
4303         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4304 }
4305
4306 #[test]
4307 fn test_no_txn_manager_serialize_deserialize() {
4308         let chanmon_cfgs = create_chanmon_cfgs(2);
4309         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4310         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4311         let logger: test_utils::TestLogger;
4312         let fee_estimator: test_utils::TestFeeEstimator;
4313         let new_chain_monitor: test_utils::TestChainMonitor;
4314         let keys_manager: test_utils::TestKeysInterface;
4315         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4316         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4317
4318         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4319
4320         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4321
4322         let nodes_0_serialized = nodes[0].node.encode();
4323         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4324         nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4325
4326         logger = test_utils::TestLogger::new();
4327         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4328         new_chain_monitor = test_utils::TestChainMonitor::new(nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4329         nodes[0].chain_monitor = &new_chain_monitor;
4330         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4331         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4332         assert!(chan_0_monitor_read.is_empty());
4333
4334         let mut nodes_0_read = &nodes_0_serialized[..];
4335         let config = UserConfig::default();
4336         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4337         let (_, nodes_0_deserialized_tmp) = {
4338                 let mut channel_monitors = HashMap::new();
4339                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4340                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4341                         default_config: config,
4342                         keys_manager: &keys_manager,
4343                         fee_estimator: &fee_estimator,
4344                         chain_monitor: nodes[0].chain_monitor,
4345                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4346                         logger: &logger,
4347                         channel_monitors,
4348                 }).unwrap()
4349         };
4350         nodes_0_deserialized = nodes_0_deserialized_tmp;
4351         assert!(nodes_0_read.is_empty());
4352
4353         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4354         nodes[0].node = &nodes_0_deserialized;
4355         nodes[0].block_notifier.register_listener(nodes[0].node);
4356         assert_eq!(nodes[0].node.list_channels().len(), 1);
4357         check_added_monitors!(nodes[0], 1);
4358
4359         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4360         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4361         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4362         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4363
4364         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4365         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4366         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4367         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4368
4369         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4370         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4371         for node in nodes.iter() {
4372                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4373                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4374                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4375         }
4376
4377         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4378 }
4379
4380 #[test]
4381 fn test_manager_serialize_deserialize_events() {
4382         // This test makes sure the events field in ChannelManager survives de/serialization
4383         let chanmon_cfgs = create_chanmon_cfgs(2);
4384         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4385         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4386         let fee_estimator: test_utils::TestFeeEstimator;
4387         let logger: test_utils::TestLogger;
4388         let new_chain_monitor: test_utils::TestChainMonitor;
4389         let keys_manager: test_utils::TestKeysInterface;
4390         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4391         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4392
4393         // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4394         let channel_value = 100000;
4395         let push_msat = 10001;
4396         let a_flags = InitFeatures::known();
4397         let b_flags = InitFeatures::known();
4398         let node_a = nodes.pop().unwrap();
4399         let node_b = nodes.pop().unwrap();
4400         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4401         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()));
4402         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()));
4403
4404         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4405
4406         node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4407         check_added_monitors!(node_a, 0);
4408
4409         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()));
4410         {
4411                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
4412                 assert_eq!(added_monitors.len(), 1);
4413                 assert_eq!(added_monitors[0].0, funding_output);
4414                 added_monitors.clear();
4415         }
4416
4417         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()));
4418         {
4419                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
4420                 assert_eq!(added_monitors.len(), 1);
4421                 assert_eq!(added_monitors[0].0, funding_output);
4422                 added_monitors.clear();
4423         }
4424         // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4425
4426         nodes.push(node_a);
4427         nodes.push(node_b);
4428
4429         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4430         let nodes_0_serialized = nodes[0].node.encode();
4431         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4432         nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4433
4434         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4435         logger = test_utils::TestLogger::new();
4436         new_chain_monitor = test_utils::TestChainMonitor::new(nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4437         nodes[0].chain_monitor = &new_chain_monitor;
4438         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4439         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4440         assert!(chan_0_monitor_read.is_empty());
4441
4442         let mut nodes_0_read = &nodes_0_serialized[..];
4443         let config = UserConfig::default();
4444         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4445         let (_, nodes_0_deserialized_tmp) = {
4446                 let mut channel_monitors = HashMap::new();
4447                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4448                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4449                         default_config: config,
4450                         keys_manager: &keys_manager,
4451                         fee_estimator: &fee_estimator,
4452                         chain_monitor: nodes[0].chain_monitor,
4453                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4454                         logger: &logger,
4455                         channel_monitors,
4456                 }).unwrap()
4457         };
4458         nodes_0_deserialized = nodes_0_deserialized_tmp;
4459         assert!(nodes_0_read.is_empty());
4460
4461         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4462
4463         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4464         nodes[0].node = &nodes_0_deserialized;
4465
4466         // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4467         let events_4 = nodes[0].node.get_and_clear_pending_events();
4468         assert_eq!(events_4.len(), 1);
4469         match events_4[0] {
4470                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4471                         assert_eq!(user_channel_id, 42);
4472                         assert_eq!(*funding_txo, funding_output);
4473                 },
4474                 _ => panic!("Unexpected event"),
4475         };
4476
4477         // Make sure the channel is functioning as though the de/serialization never happened
4478         nodes[0].block_notifier.register_listener(nodes[0].node);
4479         assert_eq!(nodes[0].node.list_channels().len(), 1);
4480         check_added_monitors!(nodes[0], 1);
4481
4482         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4483         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4484         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4485         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4486
4487         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4488         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4489         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4490         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4491
4492         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4493         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4494         for node in nodes.iter() {
4495                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4496                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4497                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4498         }
4499
4500         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4501 }
4502
4503 #[test]
4504 fn test_simple_manager_serialize_deserialize() {
4505         let chanmon_cfgs = create_chanmon_cfgs(2);
4506         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4507         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4508         let logger: test_utils::TestLogger;
4509         let fee_estimator: test_utils::TestFeeEstimator;
4510         let new_chain_monitor: test_utils::TestChainMonitor;
4511         let keys_manager: test_utils::TestKeysInterface;
4512         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4513         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4514         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4515
4516         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4517         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4518
4519         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4520
4521         let nodes_0_serialized = nodes[0].node.encode();
4522         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4523         nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4524
4525         logger = test_utils::TestLogger::new();
4526         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4527         new_chain_monitor = test_utils::TestChainMonitor::new(nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4528         nodes[0].chain_monitor = &new_chain_monitor;
4529         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4530         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4531         assert!(chan_0_monitor_read.is_empty());
4532
4533         let mut nodes_0_read = &nodes_0_serialized[..];
4534         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4535         let (_, nodes_0_deserialized_tmp) = {
4536                 let mut channel_monitors = HashMap::new();
4537                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4538                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4539                         default_config: UserConfig::default(),
4540                         keys_manager: &keys_manager,
4541                         fee_estimator: &fee_estimator,
4542                         chain_monitor: nodes[0].chain_monitor,
4543                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4544                         logger: &logger,
4545                         channel_monitors,
4546                 }).unwrap()
4547         };
4548         nodes_0_deserialized = nodes_0_deserialized_tmp;
4549         assert!(nodes_0_read.is_empty());
4550
4551         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4552         nodes[0].node = &nodes_0_deserialized;
4553         check_added_monitors!(nodes[0], 1);
4554
4555         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4556
4557         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4558         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4559 }
4560
4561 #[test]
4562 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4563         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4564         let chanmon_cfgs = create_chanmon_cfgs(4);
4565         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4566         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4567         let logger: test_utils::TestLogger;
4568         let fee_estimator: test_utils::TestFeeEstimator;
4569         let new_chain_monitor: test_utils::TestChainMonitor;
4570         let keys_manager: test_utils::TestKeysInterface;
4571         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4572         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4573         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4574         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4575         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4576
4577         let mut node_0_stale_monitors_serialized = Vec::new();
4578         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter() {
4579                 let mut writer = test_utils::TestVecWriter(Vec::new());
4580                 monitor.1.write_for_disk(&mut writer).unwrap();
4581                 node_0_stale_monitors_serialized.push(writer.0);
4582         }
4583
4584         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4585
4586         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4587         let nodes_0_serialized = nodes[0].node.encode();
4588
4589         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4590         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4591         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4592         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4593
4594         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4595         // nodes[3])
4596         let mut node_0_monitors_serialized = Vec::new();
4597         for monitor in nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter() {
4598                 let mut writer = test_utils::TestVecWriter(Vec::new());
4599                 monitor.1.write_for_disk(&mut writer).unwrap();
4600                 node_0_monitors_serialized.push(writer.0);
4601         }
4602
4603         logger = test_utils::TestLogger::new();
4604         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4605         new_chain_monitor = test_utils::TestChainMonitor::new(nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4606         nodes[0].chain_monitor = &new_chain_monitor;
4607
4608         let mut node_0_stale_monitors = Vec::new();
4609         for serialized in node_0_stale_monitors_serialized.iter() {
4610                 let mut read = &serialized[..];
4611                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4612                 assert!(read.is_empty());
4613                 node_0_stale_monitors.push(monitor);
4614         }
4615
4616         let mut node_0_monitors = Vec::new();
4617         for serialized in node_0_monitors_serialized.iter() {
4618                 let mut read = &serialized[..];
4619                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4620                 assert!(read.is_empty());
4621                 node_0_monitors.push(monitor);
4622         }
4623
4624         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4625
4626         let mut nodes_0_read = &nodes_0_serialized[..];
4627         if let Err(msgs::DecodeError::InvalidValue) =
4628                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4629                 default_config: UserConfig::default(),
4630                 keys_manager: &keys_manager,
4631                 fee_estimator: &fee_estimator,
4632                 chain_monitor: nodes[0].chain_monitor,
4633                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4634                 logger: &logger,
4635                 channel_monitors: node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4636         }) { } else {
4637                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4638         };
4639
4640         let mut nodes_0_read = &nodes_0_serialized[..];
4641         let (_, nodes_0_deserialized_tmp) =
4642                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4643                 default_config: UserConfig::default(),
4644                 keys_manager: &keys_manager,
4645                 fee_estimator: &fee_estimator,
4646                 chain_monitor: nodes[0].chain_monitor,
4647                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4648                 logger: &logger,
4649                 channel_monitors: node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4650         }).unwrap();
4651         nodes_0_deserialized = nodes_0_deserialized_tmp;
4652         assert!(nodes_0_read.is_empty());
4653
4654         { // Channel close should result in a commitment tx and an HTLC tx
4655                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4656                 assert_eq!(txn.len(), 2);
4657                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4658                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4659         }
4660
4661         for monitor in node_0_monitors.drain(..) {
4662                 assert!(nodes[0].chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor).is_ok());
4663                 check_added_monitors!(nodes[0], 1);
4664         }
4665         nodes[0].node = &nodes_0_deserialized;
4666
4667         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4668         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4669         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4670         //... and we can even still claim the payment!
4671         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4672
4673         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4674         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4675         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4676         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4677         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4678         assert_eq!(msg_events.len(), 1);
4679         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4680                 match action {
4681                         &ErrorAction::SendErrorMessage { ref msg } => {
4682                                 assert_eq!(msg.channel_id, channel_id);
4683                         },
4684                         _ => panic!("Unexpected event!"),
4685                 }
4686         }
4687 }
4688
4689 macro_rules! check_spendable_outputs {
4690         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4691                 {
4692                         let events = $node.chain_monitor.chain_monitor.get_and_clear_pending_events();
4693                         let mut txn = Vec::new();
4694                         for event in events {
4695                                 match event {
4696                                         Event::SpendableOutputs { ref outputs } => {
4697                                                 for outp in outputs {
4698                                                         match *outp {
4699                                                                 SpendableOutputDescriptor::StaticOutputCounterpartyPayment { ref outpoint, ref output, ref key_derivation_params } => {
4700                                                                         let input = TxIn {
4701                                                                                 previous_output: outpoint.into_bitcoin_outpoint(),
4702                                                                                 script_sig: Script::new(),
4703                                                                                 sequence: 0,
4704                                                                                 witness: Vec::new(),
4705                                                                         };
4706                                                                         let outp = TxOut {
4707                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4708                                                                                 value: output.value,
4709                                                                         };
4710                                                                         let mut spend_tx = Transaction {
4711                                                                                 version: 2,
4712                                                                                 lock_time: 0,
4713                                                                                 input: vec![input],
4714                                                                                 output: vec![outp],
4715                                                                         };
4716                                                                         let secp_ctx = Secp256k1::new();
4717                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4718                                                                         let remotepubkey = keys.pubkeys().payment_point;
4719                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4720                                                                         let sighash = Message::from_slice(&bip143::SigHashCache::new(&spend_tx).signature_hash(0, &witness_script, output.value, SigHashType::All)[..]).unwrap();
4721                                                                         let remotesig = secp_ctx.sign(&sighash, &keys.inner.payment_key);
4722                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4723                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4724                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4725                                                                         txn.push(spend_tx);
4726                                                                 },
4727                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref per_commitment_point, ref to_self_delay, ref output, ref key_derivation_params, ref revocation_pubkey } => {
4728                                                                         let input = TxIn {
4729                                                                                 previous_output: outpoint.into_bitcoin_outpoint(),
4730                                                                                 script_sig: Script::new(),
4731                                                                                 sequence: *to_self_delay as u32,
4732                                                                                 witness: Vec::new(),
4733                                                                         };
4734                                                                         let outp = TxOut {
4735                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4736                                                                                 value: output.value,
4737                                                                         };
4738                                                                         let mut spend_tx = Transaction {
4739                                                                                 version: 2,
4740                                                                                 lock_time: 0,
4741                                                                                 input: vec![input],
4742                                                                                 output: vec![outp],
4743                                                                         };
4744                                                                         let secp_ctx = Secp256k1::new();
4745                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4746                                                                         if let Ok(delayed_payment_key) = chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &keys.inner.delayed_payment_base_key) {
4747
4748                                                                                 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
4749                                                                                 let witness_script = chan_utils::get_revokeable_redeemscript(revocation_pubkey, *to_self_delay, &delayed_payment_pubkey);
4750                                                                                 let sighash = Message::from_slice(&bip143::SigHashCache::new(&spend_tx).signature_hash(0, &witness_script, output.value, SigHashType::All)[..]).unwrap();
4751                                                                                 let local_delayedsig = secp_ctx.sign(&sighash, &delayed_payment_key);
4752                                                                                 spend_tx.input[0].witness.push(local_delayedsig.serialize_der().to_vec());
4753                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4754                                                                                 spend_tx.input[0].witness.push(vec!()); //MINIMALIF
4755                                                                                 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4756                                                                         } else { panic!() }
4757                                                                         txn.push(spend_tx);
4758                                                                 },
4759                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4760                                                                         let secp_ctx = Secp256k1::new();
4761                                                                         let input = TxIn {
4762                                                                                 previous_output: outpoint.into_bitcoin_outpoint(),
4763                                                                                 script_sig: Script::new(),
4764                                                                                 sequence: 0,
4765                                                                                 witness: Vec::new(),
4766                                                                         };
4767                                                                         let outp = TxOut {
4768                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4769                                                                                 value: output.value,
4770                                                                         };
4771                                                                         let mut spend_tx = Transaction {
4772                                                                                 version: 2,
4773                                                                                 lock_time: 0,
4774                                                                                 input: vec![input],
4775                                                                                 output: vec![outp.clone()],
4776                                                                         };
4777                                                                         let secret = {
4778                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4779                                                                                         Ok(master_key) => {
4780                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4781                                                                                                         Ok(key) => key,
4782                                                                                                         Err(_) => panic!("Your RNG is busted"),
4783                                                                                                 }
4784                                                                                         }
4785                                                                                         Err(_) => panic!("Your rng is busted"),
4786                                                                                 }
4787                                                                         };
4788                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4789                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4790                                                                         let sighash = Message::from_slice(&bip143::SigHashCache::new(&spend_tx).signature_hash(0, &witness_script, output.value, SigHashType::All)[..]).unwrap();
4791                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4792                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4793                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4794                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4795                                                                         txn.push(spend_tx);
4796                                                                 },
4797                                                         }
4798                                                 }
4799                                         },
4800                                         _ => panic!("Unexpected event"),
4801                                 };
4802                         }
4803                         txn
4804                 }
4805         }
4806 }
4807
4808 #[test]
4809 fn test_claim_sizeable_push_msat() {
4810         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4811         let chanmon_cfgs = create_chanmon_cfgs(2);
4812         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4813         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4814         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4815
4816         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4817         nodes[1].node.force_close_channel(&chan.2);
4818         check_closed_broadcast!(nodes[1], false);
4819         check_added_monitors!(nodes[1], 1);
4820         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4821         assert_eq!(node_txn.len(), 1);
4822         check_spends!(node_txn[0], chan.3);
4823         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
4824
4825         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4826         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4827         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4828
4829         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4830         assert_eq!(spend_txn.len(), 1);
4831         check_spends!(spend_txn[0], node_txn[0]);
4832 }
4833
4834 #[test]
4835 fn test_claim_on_remote_sizeable_push_msat() {
4836         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4837         // to_remote output is encumbered by a P2WPKH
4838         let chanmon_cfgs = create_chanmon_cfgs(2);
4839         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4840         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4841         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4842
4843         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4844         nodes[0].node.force_close_channel(&chan.2);
4845         check_closed_broadcast!(nodes[0], false);
4846         check_added_monitors!(nodes[0], 1);
4847
4848         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4849         assert_eq!(node_txn.len(), 1);
4850         check_spends!(node_txn[0], chan.3);
4851         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
4852
4853         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4854         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4855         check_closed_broadcast!(nodes[1], false);
4856         check_added_monitors!(nodes[1], 1);
4857         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4858
4859         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4860         assert_eq!(spend_txn.len(), 2);
4861         assert_eq!(spend_txn[0], spend_txn[1]);
4862         check_spends!(spend_txn[0], node_txn[0]);
4863 }
4864
4865 #[test]
4866 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4867         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4868         // to_remote output is encumbered by a P2WPKH
4869
4870         let chanmon_cfgs = create_chanmon_cfgs(2);
4871         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4872         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4873         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4874
4875         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4876         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4877         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4878         assert_eq!(revoked_local_txn[0].input.len(), 1);
4879         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4880
4881         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4882         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4883         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4884         check_closed_broadcast!(nodes[1], false);
4885         check_added_monitors!(nodes[1], 1);
4886
4887         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4888         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4889         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4890         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4891
4892         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4893         assert_eq!(spend_txn.len(), 3);
4894         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4895         check_spends!(spend_txn[0], revoked_local_txn[0]);
4896         check_spends!(spend_txn[2], node_txn[0]);
4897 }
4898
4899 #[test]
4900 fn test_static_spendable_outputs_preimage_tx() {
4901         let chanmon_cfgs = create_chanmon_cfgs(2);
4902         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4903         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4904         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4905
4906         // Create some initial channels
4907         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4908
4909         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4910
4911         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4912         assert_eq!(commitment_tx[0].input.len(), 1);
4913         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4914
4915         // Settle A's commitment tx on B's chain
4916         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4917         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4918         check_added_monitors!(nodes[1], 1);
4919         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4920         check_added_monitors!(nodes[1], 1);
4921         let events = nodes[1].node.get_and_clear_pending_msg_events();
4922         match events[0] {
4923                 MessageSendEvent::UpdateHTLCs { .. } => {},
4924                 _ => panic!("Unexpected event"),
4925         }
4926         match events[1] {
4927                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4928                 _ => panic!("Unexepected event"),
4929         }
4930
4931         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4932         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4933         assert_eq!(node_txn.len(), 3);
4934         check_spends!(node_txn[0], commitment_tx[0]);
4935         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4936         check_spends!(node_txn[1], chan_1.3);
4937         check_spends!(node_txn[2], node_txn[1]);
4938
4939         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4940         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4941         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4942
4943         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4944         assert_eq!(spend_txn.len(), 1);
4945         check_spends!(spend_txn[0], node_txn[0]);
4946 }
4947
4948 #[test]
4949 fn test_static_spendable_outputs_timeout_tx() {
4950         let chanmon_cfgs = create_chanmon_cfgs(2);
4951         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4952         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4953         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4954
4955         // Create some initial channels
4956         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4957
4958         // Rebalance the network a bit by relaying one payment through all the channels ...
4959         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4960
4961         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4962
4963         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4964         assert_eq!(commitment_tx[0].input.len(), 1);
4965         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4966
4967         // Settle A's commitment tx on B' chain
4968         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4969         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4970         check_added_monitors!(nodes[1], 1);
4971         let events = nodes[1].node.get_and_clear_pending_msg_events();
4972         match events[0] {
4973                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4974                 _ => panic!("Unexpected event"),
4975         }
4976
4977         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4978         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4979         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4980         check_spends!(node_txn[0],  commitment_tx[0].clone());
4981         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4982         check_spends!(node_txn[1], chan_1.3.clone());
4983         check_spends!(node_txn[2], node_txn[1]);
4984
4985         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4986         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4987         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
4988         expect_payment_failed!(nodes[1], our_payment_hash, true);
4989
4990         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4991         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4992         check_spends!(spend_txn[2], node_txn[0].clone());
4993 }
4994
4995 #[test]
4996 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4997         let chanmon_cfgs = create_chanmon_cfgs(2);
4998         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4999         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5000         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5001
5002         // Create some initial channels
5003         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5004
5005         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5006         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5007         assert_eq!(revoked_local_txn[0].input.len(), 1);
5008         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5009
5010         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5011
5012         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5013         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
5014         check_closed_broadcast!(nodes[1], false);
5015         check_added_monitors!(nodes[1], 1);
5016
5017         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5018         assert_eq!(node_txn.len(), 2);
5019         assert_eq!(node_txn[0].input.len(), 2);
5020         check_spends!(node_txn[0], revoked_local_txn[0]);
5021
5022         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5023         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
5024         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
5025
5026         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5027         assert_eq!(spend_txn.len(), 1);
5028         check_spends!(spend_txn[0], node_txn[0]);
5029 }
5030
5031 #[test]
5032 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
5033         let chanmon_cfgs = create_chanmon_cfgs(2);
5034         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5035         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5036         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5037
5038         // Create some initial channels
5039         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5040
5041         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5042         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5043         assert_eq!(revoked_local_txn[0].input.len(), 1);
5044         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5045
5046         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5047
5048         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5049         // A will generate HTLC-Timeout from revoked commitment tx
5050         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5051         check_closed_broadcast!(nodes[0], false);
5052         check_added_monitors!(nodes[0], 1);
5053
5054         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5055         assert_eq!(revoked_htlc_txn.len(), 2);
5056         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5057         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5058         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5059         check_spends!(revoked_htlc_txn[1], chan_1.3);
5060
5061         // B will generate justice tx from A's revoked commitment/HTLC tx
5062         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
5063         check_closed_broadcast!(nodes[1], false);
5064         check_added_monitors!(nodes[1], 1);
5065
5066         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5067         assert_eq!(node_txn.len(), 3); // ChannelMonitor: bogus justice tx, justice tx on revoked outputs, ChannelManager: local commitment tx
5068         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5069         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5070         // transactions next...
5071         assert_eq!(node_txn[0].input.len(), 3);
5072         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5073
5074         assert_eq!(node_txn[1].input.len(), 2);
5075         check_spends!(node_txn[1], revoked_local_txn[0], revoked_htlc_txn[0]);
5076         if node_txn[1].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5077                 assert_ne!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5078         } else {
5079                 assert_eq!(node_txn[1].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5080                 assert_ne!(node_txn[1].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5081         }
5082
5083         assert_eq!(node_txn[2].input.len(), 1);
5084         check_spends!(node_txn[2], chan_1.3);
5085
5086         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5087         connect_block(&nodes[1], &Block { header: header_1, txdata: vec![node_txn[1].clone()] }, 1);
5088         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
5089
5090         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5091         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5092         assert_eq!(spend_txn.len(), 1);
5093         assert_eq!(spend_txn[0].input.len(), 1);
5094         check_spends!(spend_txn[0], node_txn[1]);
5095 }
5096
5097 #[test]
5098 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5099         let chanmon_cfgs = create_chanmon_cfgs(2);
5100         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5101         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5102         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5103
5104         // Create some initial channels
5105         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5106
5107         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5108         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5109         assert_eq!(revoked_local_txn[0].input.len(), 1);
5110         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5111
5112         // The to-be-revoked commitment tx should have one HTLC and one to_remote output
5113         assert_eq!(revoked_local_txn[0].output.len(), 2);
5114
5115         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5116
5117         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5118         // B will generate HTLC-Success from revoked commitment tx
5119         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5120         check_closed_broadcast!(nodes[1], false);
5121         check_added_monitors!(nodes[1], 1);
5122         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5123
5124         assert_eq!(revoked_htlc_txn.len(), 2);
5125         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5126         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5127         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5128
5129         // Check that the unspent (of two) outputs on revoked_local_txn[0] is a P2WPKH:
5130         let unspent_local_txn_output = revoked_htlc_txn[0].input[0].previous_output.vout as usize ^ 1;
5131         assert_eq!(revoked_local_txn[0].output[unspent_local_txn_output].script_pubkey.len(), 2 + 20); // P2WPKH
5132
5133         // A will generate justice tx from B's revoked commitment/HTLC tx
5134         connect_block(&nodes[0], &Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5135         check_closed_broadcast!(nodes[0], false);
5136         check_added_monitors!(nodes[0], 1);
5137
5138         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5139         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5140
5141         // The first transaction generated is bogus - it spends both outputs of revoked_local_txn[0]
5142         // including the one already spent by revoked_htlc_txn[0]. That's OK, we'll spend with valid
5143         // transactions next...
5144         assert_eq!(node_txn[0].input.len(), 2);
5145         check_spends!(node_txn[0], revoked_local_txn[0], revoked_htlc_txn[0]);
5146         if node_txn[0].input[1].previous_output.txid == revoked_htlc_txn[0].txid() {
5147                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5148         } else {
5149                 assert_eq!(node_txn[0].input[0].previous_output.txid, revoked_htlc_txn[0].txid());
5150                 assert_eq!(node_txn[0].input[1].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5151         }
5152
5153         assert_eq!(node_txn[1].input.len(), 1);
5154         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5155
5156         check_spends!(node_txn[2], chan_1.3);
5157
5158         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5159         connect_block(&nodes[0], &Block { header: header_1, txdata: vec![node_txn[1].clone()] }, 1);
5160         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 1, true, header.block_hash());
5161
5162         // Note that nodes[0]'s tx_broadcaster is still locked, so if we get here the channelmonitor
5163         // didn't try to generate any new transactions.
5164
5165         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5166         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5167         assert_eq!(spend_txn.len(), 3); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
5168         assert_eq!(spend_txn[0], spend_txn[1]);
5169         assert_eq!(spend_txn[0].input.len(), 1);
5170         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5171         assert_ne!(spend_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
5172         check_spends!(spend_txn[2], node_txn[1]); // spending justice tx output on the htlc success tx
5173 }
5174
5175 #[test]
5176 fn test_onchain_to_onchain_claim() {
5177         // Test that in case of channel closure, we detect the state of output and claim HTLC
5178         // on downstream peer's remote commitment tx.
5179         // First, have C claim an HTLC against its own latest commitment transaction.
5180         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5181         // channel.
5182         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5183         // gets broadcast.
5184
5185         let chanmon_cfgs = create_chanmon_cfgs(3);
5186         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5187         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5188         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5189
5190         // Create some initial channels
5191         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5192         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5193
5194         // Rebalance the network a bit by relaying one payment through all the channels ...
5195         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5196         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5197
5198         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5199         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5200         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5201         check_spends!(commitment_tx[0], chan_2.3);
5202         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5203         check_added_monitors!(nodes[2], 1);
5204         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5205         assert!(updates.update_add_htlcs.is_empty());
5206         assert!(updates.update_fail_htlcs.is_empty());
5207         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5208         assert!(updates.update_fail_malformed_htlcs.is_empty());
5209
5210         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5211         check_closed_broadcast!(nodes[2], false);
5212         check_added_monitors!(nodes[2], 1);
5213
5214         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5215         assert_eq!(c_txn.len(), 3);
5216         assert_eq!(c_txn[0], c_txn[2]);
5217         assert_eq!(commitment_tx[0], c_txn[1]);
5218         check_spends!(c_txn[1], chan_2.3);
5219         check_spends!(c_txn[2], c_txn[1]);
5220         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5221         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5222         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5223         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5224
5225         // 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
5226         connect_block(&nodes[1], &Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5227         {
5228                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5229                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5230                 assert_eq!(b_txn.len(), 3);
5231                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5232                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5233                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5234                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5235                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5236                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
5237                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5238                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5239                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5240                 b_txn.clear();
5241         }
5242         check_added_monitors!(nodes[1], 1);
5243         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5244         check_added_monitors!(nodes[1], 1);
5245         match msg_events[0] {
5246                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
5247                 _ => panic!("Unexpected event"),
5248         }
5249         match msg_events[1] {
5250                 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, .. } } => {
5251                         assert!(update_add_htlcs.is_empty());
5252                         assert!(update_fail_htlcs.is_empty());
5253                         assert_eq!(update_fulfill_htlcs.len(), 1);
5254                         assert!(update_fail_malformed_htlcs.is_empty());
5255                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5256                 },
5257                 _ => panic!("Unexpected event"),
5258         };
5259         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5260         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5261         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5262         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5263         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5264         assert_eq!(b_txn.len(), 3);
5265         check_spends!(b_txn[1], chan_1.3);
5266         check_spends!(b_txn[2], b_txn[1]);
5267         check_spends!(b_txn[0], commitment_tx[0]);
5268         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5269         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5270         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5271
5272         check_closed_broadcast!(nodes[1], false);
5273         check_added_monitors!(nodes[1], 1);
5274 }
5275
5276 #[test]
5277 fn test_duplicate_payment_hash_one_failure_one_success() {
5278         // Topology : A --> B --> C
5279         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5280         let chanmon_cfgs = create_chanmon_cfgs(3);
5281         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5282         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5283         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5284
5285         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5286         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5287
5288         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5289         *nodes[0].network_payment_count.borrow_mut() -= 1;
5290         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5291
5292         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5293         assert_eq!(commitment_txn[0].input.len(), 1);
5294         check_spends!(commitment_txn[0], chan_2.3);
5295
5296         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5297         connect_block(&nodes[1], &Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5298         check_closed_broadcast!(nodes[1], false);
5299         check_added_monitors!(nodes[1], 1);
5300
5301         let htlc_timeout_tx;
5302         { // Extract one of the two HTLC-Timeout transaction
5303                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5304                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5305                 assert_eq!(node_txn.len(), 5);
5306                 check_spends!(node_txn[0], commitment_txn[0]);
5307                 assert_eq!(node_txn[0].input.len(), 1);
5308                 check_spends!(node_txn[1], commitment_txn[0]);
5309                 assert_eq!(node_txn[1].input.len(), 1);
5310                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5311                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5312                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5313                 check_spends!(node_txn[2], chan_2.3);
5314                 check_spends!(node_txn[3], node_txn[2]);
5315                 check_spends!(node_txn[4], node_txn[2]);
5316                 htlc_timeout_tx = node_txn[1].clone();
5317         }
5318
5319         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5320         connect_block(&nodes[2], &Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5321         check_added_monitors!(nodes[2], 3);
5322         let events = nodes[2].node.get_and_clear_pending_msg_events();
5323         match events[0] {
5324                 MessageSendEvent::UpdateHTLCs { .. } => {},
5325                 _ => panic!("Unexpected event"),
5326         }
5327         match events[1] {
5328                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5329                 _ => panic!("Unexepected event"),
5330         }
5331         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5332         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)
5333         check_spends!(htlc_success_txn[2], chan_2.3);
5334         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5335         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5336         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5337         assert_eq!(htlc_success_txn[0].input.len(), 1);
5338         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5339         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5340         assert_eq!(htlc_success_txn[1].input.len(), 1);
5341         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5342         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5343         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5344         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5345
5346         connect_block(&nodes[1], &Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5347         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 200, true, header.block_hash());
5348         expect_pending_htlcs_forwardable!(nodes[1]);
5349         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5350         assert!(htlc_updates.update_add_htlcs.is_empty());
5351         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5352         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5353         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5354         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5355         check_added_monitors!(nodes[1], 1);
5356
5357         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5358         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5359         {
5360                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5361                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5362                 assert_eq!(events.len(), 1);
5363                 match events[0] {
5364                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5365                         },
5366                         _ => { panic!("Unexpected event"); }
5367                 }
5368         }
5369         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5370
5371         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5372         connect_block(&nodes[1], &Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5373         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5374         assert!(updates.update_add_htlcs.is_empty());
5375         assert!(updates.update_fail_htlcs.is_empty());
5376         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5377         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5378         assert!(updates.update_fail_malformed_htlcs.is_empty());
5379         check_added_monitors!(nodes[1], 1);
5380
5381         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5382         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5383
5384         let events = nodes[0].node.get_and_clear_pending_events();
5385         match events[0] {
5386                 Event::PaymentSent { ref payment_preimage } => {
5387                         assert_eq!(*payment_preimage, our_payment_preimage);
5388                 }
5389                 _ => panic!("Unexpected event"),
5390         }
5391 }
5392
5393 #[test]
5394 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5395         let chanmon_cfgs = create_chanmon_cfgs(2);
5396         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5397         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5398         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5399
5400         // Create some initial channels
5401         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5402
5403         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5404         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5405         assert_eq!(local_txn[0].input.len(), 1);
5406         check_spends!(local_txn[0], chan_1.3);
5407
5408         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5409         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5410         check_added_monitors!(nodes[1], 1);
5411         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5412         connect_block(&nodes[1], &Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5413         check_added_monitors!(nodes[1], 1);
5414         let events = nodes[1].node.get_and_clear_pending_msg_events();
5415         match events[0] {
5416                 MessageSendEvent::UpdateHTLCs { .. } => {},
5417                 _ => panic!("Unexpected event"),
5418         }
5419         match events[1] {
5420                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5421                 _ => panic!("Unexepected event"),
5422         }
5423         let node_txn = {
5424                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5425                 assert_eq!(node_txn[0].input.len(), 1);
5426                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5427                 check_spends!(node_txn[0], local_txn[0]);
5428                 vec![node_txn[0].clone(), node_txn[2].clone()]
5429         };
5430
5431         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5432         connect_block(&nodes[1], &Block { header: header_201, txdata: node_txn.clone() }, 201);
5433         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
5434
5435         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5436         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5437         assert_eq!(spend_txn.len(), 2);
5438         check_spends!(spend_txn[0], node_txn[0]);
5439         check_spends!(spend_txn[1], node_txn[1]);
5440 }
5441
5442 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5443         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5444         // unrevoked commitment transaction.
5445         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5446         // a remote RAA before they could be failed backwards (and combinations thereof).
5447         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5448         // use the same payment hashes.
5449         // Thus, we use a six-node network:
5450         //
5451         // A \         / E
5452         //    - C - D -
5453         // B /         \ F
5454         // And test where C fails back to A/B when D announces its latest commitment transaction
5455         let chanmon_cfgs = create_chanmon_cfgs(6);
5456         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5457         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5458         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5459         let logger = test_utils::TestLogger::new();
5460
5461         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5462         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5463         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5464         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5465         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5466
5467         // Rebalance and check output sanity...
5468         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5469         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5470         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5471
5472         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
5473         // 0th HTLC:
5474         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
5475         // 1st HTLC:
5476         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
5477         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5478         let our_node_id = &nodes[1].node.get_our_node_id();
5479         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();
5480         // 2nd HTLC:
5481         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
5482         // 3rd HTLC:
5483         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
5484         // 4th HTLC:
5485         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5486         // 5th HTLC:
5487         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5488         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();
5489         // 6th HTLC:
5490         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5491         // 7th HTLC:
5492         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5493
5494         // 8th HTLC:
5495         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5496         // 9th HTLC:
5497         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();
5498         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
5499
5500         // 10th HTLC:
5501         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
5502         // 11th HTLC:
5503         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();
5504         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5505
5506         // Double-check that six of the new HTLC were added
5507         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5508         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5509         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5510         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5511
5512         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5513         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5514         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5515         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5516         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5517         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5518         check_added_monitors!(nodes[4], 0);
5519         expect_pending_htlcs_forwardable!(nodes[4]);
5520         check_added_monitors!(nodes[4], 1);
5521
5522         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5523         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5524         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5525         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5526         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5527         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5528
5529         // Fail 3rd below-dust and 7th above-dust HTLCs
5530         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5531         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5532         check_added_monitors!(nodes[5], 0);
5533         expect_pending_htlcs_forwardable!(nodes[5]);
5534         check_added_monitors!(nodes[5], 1);
5535
5536         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5537         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5538         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5539         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5540
5541         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5542
5543         expect_pending_htlcs_forwardable!(nodes[3]);
5544         check_added_monitors!(nodes[3], 1);
5545         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5546         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5547         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5548         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5549         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5550         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5551         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5552         if deliver_last_raa {
5553                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5554         } else {
5555                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5556         }
5557
5558         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5559         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5560         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5561         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5562         //
5563         // We now broadcast the latest commitment transaction, which *should* result in failures for
5564         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5565         // the non-broadcast above-dust HTLCs.
5566         //
5567         // Alternatively, we may broadcast the previous commitment transaction, which should only
5568         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5569         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5570
5571         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5572         if announce_latest {
5573                 connect_block(&nodes[2], &Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
5574         } else {
5575                 connect_block(&nodes[2], &Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
5576         }
5577         connect_blocks(&nodes[2], ANTI_REORG_DELAY - 1, 1, true,  header.block_hash());
5578         check_closed_broadcast!(nodes[2], false);
5579         expect_pending_htlcs_forwardable!(nodes[2]);
5580         check_added_monitors!(nodes[2], 3);
5581
5582         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5583         assert_eq!(cs_msgs.len(), 2);
5584         let mut a_done = false;
5585         for msg in cs_msgs {
5586                 match msg {
5587                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5588                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5589                                 // should be failed-backwards here.
5590                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5591                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5592                                         for htlc in &updates.update_fail_htlcs {
5593                                                 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 });
5594                                         }
5595                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5596                                         assert!(!a_done);
5597                                         a_done = true;
5598                                         &nodes[0]
5599                                 } else {
5600                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5601                                         for htlc in &updates.update_fail_htlcs {
5602                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5603                                         }
5604                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5605                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5606                                         &nodes[1]
5607                                 };
5608                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5609                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5610                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5611                                 if announce_latest {
5612                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5613                                         if *node_id == nodes[0].node.get_our_node_id() {
5614                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5615                                         }
5616                                 }
5617                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5618                         },
5619                         _ => panic!("Unexpected event"),
5620                 }
5621         }
5622
5623         let as_events = nodes[0].node.get_and_clear_pending_events();
5624         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5625         let mut as_failds = HashSet::new();
5626         for event in as_events.iter() {
5627                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5628                         assert!(as_failds.insert(*payment_hash));
5629                         if *payment_hash != payment_hash_2 {
5630                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5631                         } else {
5632                                 assert!(!rejected_by_dest);
5633                         }
5634                 } else { panic!("Unexpected event"); }
5635         }
5636         assert!(as_failds.contains(&payment_hash_1));
5637         assert!(as_failds.contains(&payment_hash_2));
5638         if announce_latest {
5639                 assert!(as_failds.contains(&payment_hash_3));
5640                 assert!(as_failds.contains(&payment_hash_5));
5641         }
5642         assert!(as_failds.contains(&payment_hash_6));
5643
5644         let bs_events = nodes[1].node.get_and_clear_pending_events();
5645         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5646         let mut bs_failds = HashSet::new();
5647         for event in bs_events.iter() {
5648                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5649                         assert!(bs_failds.insert(*payment_hash));
5650                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5651                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5652                         } else {
5653                                 assert!(!rejected_by_dest);
5654                         }
5655                 } else { panic!("Unexpected event"); }
5656         }
5657         assert!(bs_failds.contains(&payment_hash_1));
5658         assert!(bs_failds.contains(&payment_hash_2));
5659         if announce_latest {
5660                 assert!(bs_failds.contains(&payment_hash_4));
5661         }
5662         assert!(bs_failds.contains(&payment_hash_5));
5663
5664         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5665         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5666         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5667         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5668         // PaymentFailureNetworkUpdates.
5669         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5670         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5671         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5672         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5673         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5674                 match event {
5675                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5676                         _ => panic!("Unexpected event"),
5677                 }
5678         }
5679 }
5680
5681 #[test]
5682 fn test_fail_backwards_latest_remote_announce_a() {
5683         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5684 }
5685
5686 #[test]
5687 fn test_fail_backwards_latest_remote_announce_b() {
5688         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5689 }
5690
5691 #[test]
5692 fn test_fail_backwards_previous_remote_announce() {
5693         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5694         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5695         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5696 }
5697
5698 #[test]
5699 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5700         let chanmon_cfgs = create_chanmon_cfgs(2);
5701         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5702         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5703         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5704
5705         // Create some initial channels
5706         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5707
5708         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5709         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5710         assert_eq!(local_txn[0].input.len(), 1);
5711         check_spends!(local_txn[0], chan_1.3);
5712
5713         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5714         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5715         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5716         check_closed_broadcast!(nodes[0], false);
5717         check_added_monitors!(nodes[0], 1);
5718
5719         let htlc_timeout = {
5720                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5721                 assert_eq!(node_txn[0].input.len(), 1);
5722                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5723                 check_spends!(node_txn[0], local_txn[0]);
5724                 node_txn[0].clone()
5725         };
5726
5727         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5728         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5729         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
5730         expect_payment_failed!(nodes[0], our_payment_hash, true);
5731
5732         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5733         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5734         assert_eq!(spend_txn.len(), 3);
5735         assert_eq!(spend_txn[0], spend_txn[1]);
5736         check_spends!(spend_txn[0], local_txn[0]);
5737         check_spends!(spend_txn[2], htlc_timeout);
5738 }
5739
5740 #[test]
5741 fn test_key_derivation_params() {
5742         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5743         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5744         // let us re-derive the channel key set to then derive a delayed_payment_key.
5745
5746         let chanmon_cfgs = create_chanmon_cfgs(3);
5747
5748         // We manually create the node configuration to backup the seed.
5749         let seed = [42; 32];
5750         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5751         let chain_monitor = test_utils::TestChainMonitor::new(&chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator);
5752         let node = NodeCfg { chain_source: &chanmon_cfgs[0].chain_source, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, chain_monitor, keys_manager, node_seed: seed };
5753         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5754         node_cfgs.remove(0);
5755         node_cfgs.insert(0, node);
5756
5757         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5758         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5759
5760         // Create some initial channels
5761         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5762         // for node 0
5763         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5764         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5765         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5766
5767         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5768         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5769         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5770         assert_eq!(local_txn_1[0].input.len(), 1);
5771         check_spends!(local_txn_1[0], chan_1.3);
5772
5773         // We check funding pubkey are unique
5774         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]));
5775         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]));
5776         if from_0_funding_key_0 == from_1_funding_key_0
5777             || from_0_funding_key_0 == from_1_funding_key_1
5778             || from_0_funding_key_1 == from_1_funding_key_0
5779             || from_0_funding_key_1 == from_1_funding_key_1 {
5780                 panic!("Funding pubkeys aren't unique");
5781         }
5782
5783         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5784         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5785         connect_block(&nodes[0], &Block { header, txdata: vec![local_txn_1[0].clone()] }, 200);
5786         check_closed_broadcast!(nodes[0], false);
5787         check_added_monitors!(nodes[0], 1);
5788
5789         let htlc_timeout = {
5790                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5791                 assert_eq!(node_txn[0].input.len(), 1);
5792                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5793                 check_spends!(node_txn[0], local_txn_1[0]);
5794                 node_txn[0].clone()
5795         };
5796
5797         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5798         connect_block(&nodes[0], &Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5799         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 201, true, header_201.block_hash());
5800         expect_payment_failed!(nodes[0], our_payment_hash, true);
5801
5802         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5803         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5804         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5805         assert_eq!(spend_txn.len(), 3);
5806         assert_eq!(spend_txn[0], spend_txn[1]);
5807         check_spends!(spend_txn[0], local_txn_1[0]);
5808         check_spends!(spend_txn[2], htlc_timeout);
5809 }
5810
5811 #[test]
5812 fn test_static_output_closing_tx() {
5813         let chanmon_cfgs = create_chanmon_cfgs(2);
5814         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5815         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5816         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5817
5818         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5819
5820         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5821         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5822
5823         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5824         connect_block(&nodes[0], &Block { header, txdata: vec![closing_tx.clone()] }, 0);
5825         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 0, true, header.block_hash());
5826
5827         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5828         assert_eq!(spend_txn.len(), 1);
5829         check_spends!(spend_txn[0], closing_tx);
5830
5831         connect_block(&nodes[1], &Block { header, txdata: vec![closing_tx.clone()] }, 0);
5832         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1, 0, true, header.block_hash());
5833
5834         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5835         assert_eq!(spend_txn.len(), 1);
5836         check_spends!(spend_txn[0], closing_tx);
5837 }
5838
5839 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5840         let chanmon_cfgs = create_chanmon_cfgs(2);
5841         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5842         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5843         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5844         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5845
5846         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5847
5848         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5849         // present in B's local commitment transaction, but none of A's commitment transactions.
5850         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5851         check_added_monitors!(nodes[1], 1);
5852
5853         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5854         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5855         let events = nodes[0].node.get_and_clear_pending_events();
5856         assert_eq!(events.len(), 1);
5857         match events[0] {
5858                 Event::PaymentSent { payment_preimage } => {
5859                         assert_eq!(payment_preimage, our_payment_preimage);
5860                 },
5861                 _ => panic!("Unexpected event"),
5862         }
5863
5864         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5865         check_added_monitors!(nodes[0], 1);
5866         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5867         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5868         check_added_monitors!(nodes[1], 1);
5869
5870         let mut block = Block {
5871                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5872                 txdata: vec![],
5873         };
5874         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5875                 connect_block(&nodes[1], &block, i);
5876                 block.header.prev_blockhash = block.block_hash();
5877         }
5878         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5879         check_closed_broadcast!(nodes[1], false);
5880         check_added_monitors!(nodes[1], 1);
5881 }
5882
5883 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5884         let chanmon_cfgs = create_chanmon_cfgs(2);
5885         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5886         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5887         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5888         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5889         let logger = test_utils::TestLogger::new();
5890
5891         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5892         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5893         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();
5894         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5895         check_added_monitors!(nodes[0], 1);
5896
5897         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5898
5899         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5900         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5901         // to "time out" the HTLC.
5902
5903         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5904
5905         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5906                 connect_block(&nodes[0], &Block { header, txdata: Vec::new()}, i);
5907                 header.prev_blockhash = header.block_hash();
5908         }
5909         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5910         check_closed_broadcast!(nodes[0], false);
5911         check_added_monitors!(nodes[0], 1);
5912 }
5913
5914 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5915         let chanmon_cfgs = create_chanmon_cfgs(3);
5916         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5917         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5918         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5919         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5920
5921         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5922         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5923         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5924         // actually revoked.
5925         let htlc_value = if use_dust { 50000 } else { 3000000 };
5926         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5927         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5928         expect_pending_htlcs_forwardable!(nodes[1]);
5929         check_added_monitors!(nodes[1], 1);
5930
5931         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5932         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5933         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5934         check_added_monitors!(nodes[0], 1);
5935         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5936         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5937         check_added_monitors!(nodes[1], 1);
5938         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5939         check_added_monitors!(nodes[1], 1);
5940         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5941
5942         if check_revoke_no_close {
5943                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5944                 check_added_monitors!(nodes[0], 1);
5945         }
5946
5947         let mut block = Block {
5948                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5949                 txdata: vec![],
5950         };
5951         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5952                 connect_block(&nodes[0], &block, i);
5953                 block.header.prev_blockhash = block.block_hash();
5954         }
5955         if !check_revoke_no_close {
5956                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5957                 check_closed_broadcast!(nodes[0], false);
5958                 check_added_monitors!(nodes[0], 1);
5959         } else {
5960                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5961         }
5962 }
5963
5964 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5965 // There are only a few cases to test here:
5966 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5967 //    broadcastable commitment transactions result in channel closure,
5968 //  * its included in an unrevoked-but-previous remote commitment transaction,
5969 //  * its included in the latest remote or local commitment transactions.
5970 // We test each of the three possible commitment transactions individually and use both dust and
5971 // non-dust HTLCs.
5972 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5973 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5974 // tested for at least one of the cases in other tests.
5975 #[test]
5976 fn htlc_claim_single_commitment_only_a() {
5977         do_htlc_claim_local_commitment_only(true);
5978         do_htlc_claim_local_commitment_only(false);
5979
5980         do_htlc_claim_current_remote_commitment_only(true);
5981         do_htlc_claim_current_remote_commitment_only(false);
5982 }
5983
5984 #[test]
5985 fn htlc_claim_single_commitment_only_b() {
5986         do_htlc_claim_previous_remote_commitment_only(true, false);
5987         do_htlc_claim_previous_remote_commitment_only(false, false);
5988         do_htlc_claim_previous_remote_commitment_only(true, true);
5989         do_htlc_claim_previous_remote_commitment_only(false, true);
5990 }
5991
5992 #[test]
5993 #[should_panic]
5994 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5995         let chanmon_cfgs = create_chanmon_cfgs(2);
5996         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5997         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5998         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5999         //Force duplicate channel ids
6000         for node in nodes.iter() {
6001                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6002         }
6003
6004         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6005         let channel_value_satoshis=10000;
6006         let push_msat=10001;
6007         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6008         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6009         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6010
6011         //Create a second channel with a channel_id collision
6012         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6013 }
6014
6015 #[test]
6016 fn bolt2_open_channel_sending_node_checks_part2() {
6017         let chanmon_cfgs = create_chanmon_cfgs(2);
6018         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6019         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6020         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6021
6022         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6023         let channel_value_satoshis=2^24;
6024         let push_msat=10001;
6025         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6026
6027         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6028         let channel_value_satoshis=10000;
6029         // Test when push_msat is equal to 1000 * funding_satoshis.
6030         let push_msat=1000*channel_value_satoshis+1;
6031         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6032
6033         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6034         let channel_value_satoshis=10000;
6035         let push_msat=10001;
6036         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
6037         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6038         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6039
6040         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6041         // 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
6042         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6043
6044         // 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.
6045         assert!(BREAKDOWN_TIMEOUT>0);
6046         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6047
6048         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6049         let chain_hash=genesis_block(Network::Testnet).header.block_hash();
6050         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6051
6052         // 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.
6053         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6054         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6055         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6056         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6057         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6058 }
6059
6060 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6061 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6062 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6063 // is no longer affordable once it's freed.
6064 #[test]
6065 fn test_fail_holding_cell_htlc_upon_free() {
6066         let chanmon_cfgs = create_chanmon_cfgs(2);
6067         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6068         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6069         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6070         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6071         let logger = test_utils::TestLogger::new();
6072
6073         // First nodes[0] generates an update_fee, setting the channel's
6074         // pending_update_fee.
6075         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6076         check_added_monitors!(nodes[0], 1);
6077
6078         let events = nodes[0].node.get_and_clear_pending_msg_events();
6079         assert_eq!(events.len(), 1);
6080         let (update_msg, commitment_signed) = match events[0] {
6081                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6082                         (update_fee.as_ref(), commitment_signed)
6083                 },
6084                 _ => panic!("Unexpected event"),
6085         };
6086
6087         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6088
6089         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6090         let channel_reserve = chan_stat.channel_reserve_msat;
6091         let feerate = get_feerate!(nodes[0], chan.2);
6092
6093         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6094         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6095         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6096         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6097         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();
6098
6099         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6100         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6101         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6102         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6103
6104         // Flush the pending fee update.
6105         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6106         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6107         check_added_monitors!(nodes[1], 1);
6108         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6109         check_added_monitors!(nodes[0], 1);
6110
6111         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6112         // HTLC, but now that the fee has been raised the payment will now fail, causing
6113         // us to surface its failure to the user.
6114         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6115         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6116         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6117         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", log_bytes!(our_payment_hash.0), chan_stat.channel_reserve_msat);
6118         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6119
6120         // Check that the payment failed to be sent out.
6121         let events = nodes[0].node.get_and_clear_pending_events();
6122         assert_eq!(events.len(), 1);
6123         match &events[0] {
6124                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6125                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6126                         assert_eq!(*rejected_by_dest, false);
6127                         assert_eq!(*error_code, None);
6128                         assert_eq!(*error_data, None);
6129                 },
6130                 _ => panic!("Unexpected event"),
6131         }
6132 }
6133
6134 // Test that if multiple HTLCs are released from the holding cell and one is
6135 // valid but the other is no longer valid upon release, the valid HTLC can be
6136 // successfully completed while the other one fails as expected.
6137 #[test]
6138 fn test_free_and_fail_holding_cell_htlcs() {
6139         let chanmon_cfgs = create_chanmon_cfgs(2);
6140         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6141         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6142         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6143         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6144         let logger = test_utils::TestLogger::new();
6145
6146         // First nodes[0] generates an update_fee, setting the channel's
6147         // pending_update_fee.
6148         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6149         check_added_monitors!(nodes[0], 1);
6150
6151         let events = nodes[0].node.get_and_clear_pending_msg_events();
6152         assert_eq!(events.len(), 1);
6153         let (update_msg, commitment_signed) = match events[0] {
6154                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6155                         (update_fee.as_ref(), commitment_signed)
6156                 },
6157                 _ => panic!("Unexpected event"),
6158         };
6159
6160         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6161
6162         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6163         let channel_reserve = chan_stat.channel_reserve_msat;
6164         let feerate = get_feerate!(nodes[0], chan.2);
6165
6166         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6167         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6168         let amt_1 = 20000;
6169         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6170         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6171         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6172         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();
6173         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();
6174
6175         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6176         nodes[0].node.send_payment(&route_1, payment_hash_1, &None).unwrap();
6177         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6178         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6179         nodes[0].node.send_payment(&route_2, payment_hash_2, &None).unwrap();
6180         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6181         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6182
6183         // Flush the pending fee update.
6184         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6185         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6186         check_added_monitors!(nodes[1], 1);
6187         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6188         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6189         check_added_monitors!(nodes[0], 2);
6190
6191         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6192         // but now that the fee has been raised the second payment will now fail, causing us
6193         // to surface its failure to the user. The first payment should succeed.
6194         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6195         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6196         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6197         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", log_bytes!(payment_hash_2.0), chan_stat.channel_reserve_msat);
6198         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6199
6200         // Check that the second payment failed to be sent out.
6201         let events = nodes[0].node.get_and_clear_pending_events();
6202         assert_eq!(events.len(), 1);
6203         match &events[0] {
6204                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6205                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6206                         assert_eq!(*rejected_by_dest, false);
6207                         assert_eq!(*error_code, None);
6208                         assert_eq!(*error_data, None);
6209                 },
6210                 _ => panic!("Unexpected event"),
6211         }
6212
6213         // Complete the first payment and the RAA from the fee update.
6214         let (payment_event, send_raa_event) = {
6215                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6216                 assert_eq!(msgs.len(), 2);
6217                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6218         };
6219         let raa = match send_raa_event {
6220                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6221                 _ => panic!("Unexpected event"),
6222         };
6223         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6224         check_added_monitors!(nodes[1], 1);
6225         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6226         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6227         let events = nodes[1].node.get_and_clear_pending_events();
6228         assert_eq!(events.len(), 1);
6229         match events[0] {
6230                 Event::PendingHTLCsForwardable { .. } => {},
6231                 _ => panic!("Unexpected event"),
6232         }
6233         nodes[1].node.process_pending_htlc_forwards();
6234         let events = nodes[1].node.get_and_clear_pending_events();
6235         assert_eq!(events.len(), 1);
6236         match events[0] {
6237                 Event::PaymentReceived { .. } => {},
6238                 _ => panic!("Unexpected event"),
6239         }
6240         nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
6241         check_added_monitors!(nodes[1], 1);
6242         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6243         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6244         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6245         let events = nodes[0].node.get_and_clear_pending_events();
6246         assert_eq!(events.len(), 1);
6247         match events[0] {
6248                 Event::PaymentSent { ref payment_preimage } => {
6249                         assert_eq!(*payment_preimage, payment_preimage_1);
6250                 }
6251                 _ => panic!("Unexpected event"),
6252         }
6253 }
6254
6255 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6256 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6257 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6258 // once it's freed.
6259 #[test]
6260 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6261         let chanmon_cfgs = create_chanmon_cfgs(3);
6262         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6263         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6264         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6265         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6266         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6267         let logger = test_utils::TestLogger::new();
6268
6269         // First nodes[1] generates an update_fee, setting the channel's
6270         // pending_update_fee.
6271         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6272         check_added_monitors!(nodes[1], 1);
6273
6274         let events = nodes[1].node.get_and_clear_pending_msg_events();
6275         assert_eq!(events.len(), 1);
6276         let (update_msg, commitment_signed) = match events[0] {
6277                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6278                         (update_fee.as_ref(), commitment_signed)
6279                 },
6280                 _ => panic!("Unexpected event"),
6281         };
6282
6283         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6284
6285         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6286         let channel_reserve = chan_stat.channel_reserve_msat;
6287         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6288
6289         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6290         let feemsat = 239;
6291         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6292         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6293         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6294         let payment_event = {
6295                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6296                 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();
6297                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6298                 check_added_monitors!(nodes[0], 1);
6299
6300                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6301                 assert_eq!(events.len(), 1);
6302
6303                 SendEvent::from_event(events.remove(0))
6304         };
6305         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6306         check_added_monitors!(nodes[1], 0);
6307         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6308         expect_pending_htlcs_forwardable!(nodes[1]);
6309
6310         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6311         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6312
6313         // Flush the pending fee update.
6314         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6315         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6316         check_added_monitors!(nodes[2], 1);
6317         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6318         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6319         check_added_monitors!(nodes[1], 2);
6320
6321         // A final RAA message is generated to finalize the fee update.
6322         let events = nodes[1].node.get_and_clear_pending_msg_events();
6323         assert_eq!(events.len(), 1);
6324
6325         let raa_msg = match &events[0] {
6326                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6327                         msg.clone()
6328                 },
6329                 _ => panic!("Unexpected event"),
6330         };
6331
6332         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6333         check_added_monitors!(nodes[2], 1);
6334         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6335
6336         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6337         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6338         assert_eq!(process_htlc_forwards_event.len(), 1);
6339         match &process_htlc_forwards_event[0] {
6340                 &Event::PendingHTLCsForwardable { .. } => {},
6341                 _ => panic!("Unexpected event"),
6342         }
6343
6344         // In response, we call ChannelManager's process_pending_htlc_forwards
6345         nodes[1].node.process_pending_htlc_forwards();
6346         check_added_monitors!(nodes[1], 1);
6347
6348         // This causes the HTLC to be failed backwards.
6349         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6350         assert_eq!(fail_event.len(), 1);
6351         let (fail_msg, commitment_signed) = match &fail_event[0] {
6352                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6353                         assert_eq!(updates.update_add_htlcs.len(), 0);
6354                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6355                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6356                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6357                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6358                 },
6359                 _ => panic!("Unexpected event"),
6360         };
6361
6362         // Pass the failure messages back to nodes[0].
6363         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6364         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6365
6366         // Complete the HTLC failure+removal process.
6367         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6368         check_added_monitors!(nodes[0], 1);
6369         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6370         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6371         check_added_monitors!(nodes[1], 2);
6372         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6373         assert_eq!(final_raa_event.len(), 1);
6374         let raa = match &final_raa_event[0] {
6375                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6376                 _ => panic!("Unexpected event"),
6377         };
6378         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6379         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6380         assert_eq!(fail_msg_event.len(), 1);
6381         match &fail_msg_event[0] {
6382                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6383                 _ => panic!("Unexpected event"),
6384         }
6385         let failure_event = nodes[0].node.get_and_clear_pending_events();
6386         assert_eq!(failure_event.len(), 1);
6387         match &failure_event[0] {
6388                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6389                         assert!(!rejected_by_dest);
6390                 },
6391                 _ => panic!("Unexpected event"),
6392         }
6393         check_added_monitors!(nodes[0], 1);
6394 }
6395
6396 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6397 // 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.
6398 //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.
6399
6400 #[test]
6401 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6402         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6403         let chanmon_cfgs = create_chanmon_cfgs(2);
6404         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6405         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6406         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6407         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6408
6409         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6410         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6411         let logger = test_utils::TestLogger::new();
6412         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();
6413         route.paths[0][0].fee_msat = 100;
6414
6415         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6416                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6417         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6418         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6419 }
6420
6421 #[test]
6422 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6423         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6424         let chanmon_cfgs = create_chanmon_cfgs(2);
6425         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6426         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6427         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6428         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6429         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6430
6431         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6432         let logger = test_utils::TestLogger::new();
6433         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();
6434         route.paths[0][0].fee_msat = 0;
6435         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6436                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6437
6438         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6439         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6440 }
6441
6442 #[test]
6443 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6444         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6445         let chanmon_cfgs = create_chanmon_cfgs(2);
6446         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6447         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6448         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6449         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6450
6451         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6452         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6453         let logger = test_utils::TestLogger::new();
6454         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();
6455         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6456         check_added_monitors!(nodes[0], 1);
6457         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6458         updates.update_add_htlcs[0].amount_msat = 0;
6459
6460         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6461         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6462         check_closed_broadcast!(nodes[1], true).unwrap();
6463         check_added_monitors!(nodes[1], 1);
6464 }
6465
6466 #[test]
6467 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6468         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6469         //It is enforced when constructing a route.
6470         let chanmon_cfgs = create_chanmon_cfgs(2);
6471         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6472         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6473         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6474         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::known(), InitFeatures::known());
6475         let logger = test_utils::TestLogger::new();
6476
6477         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6478
6479         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6480         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();
6481         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6482                 assert_eq!(err, &"Channel CLTV overflowed?"));
6483 }
6484
6485 #[test]
6486 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6487         //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.
6488         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6489         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6490         let chanmon_cfgs = create_chanmon_cfgs(2);
6491         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6492         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6493         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6494         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6495         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().counterparty_max_accepted_htlcs as u64;
6496
6497         let logger = test_utils::TestLogger::new();
6498         for i in 0..max_accepted_htlcs {
6499                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6500                 let payment_event = {
6501                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6502                         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();
6503                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6504                         check_added_monitors!(nodes[0], 1);
6505
6506                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6507                         assert_eq!(events.len(), 1);
6508                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6509                                 assert_eq!(htlcs[0].htlc_id, i);
6510                         } else {
6511                                 assert!(false);
6512                         }
6513                         SendEvent::from_event(events.remove(0))
6514                 };
6515                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6516                 check_added_monitors!(nodes[1], 0);
6517                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6518
6519                 expect_pending_htlcs_forwardable!(nodes[1]);
6520                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6521         }
6522         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6523         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6524         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();
6525         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6526                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6527
6528         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6529         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6530 }
6531
6532 #[test]
6533 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6534         //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.
6535         let chanmon_cfgs = create_chanmon_cfgs(2);
6536         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6537         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6538         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6539         let channel_value = 100000;
6540         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6541         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).counterparty_max_htlc_value_in_flight_msat;
6542
6543         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6544
6545         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6546         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6547         let logger = test_utils::TestLogger::new();
6548         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();
6549         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6550                 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)));
6551
6552         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6553         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);
6554
6555         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6556 }
6557
6558 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6559 #[test]
6560 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6561         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6562         let chanmon_cfgs = create_chanmon_cfgs(2);
6563         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6564         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6565         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6566         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6567         let htlc_minimum_msat: u64;
6568         {
6569                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6570                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6571                 htlc_minimum_msat = channel.get_holder_htlc_minimum_msat();
6572         }
6573
6574         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6575         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6576         let logger = test_utils::TestLogger::new();
6577         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();
6578         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6579         check_added_monitors!(nodes[0], 1);
6580         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6581         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6582         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6583         assert!(nodes[1].node.list_channels().is_empty());
6584         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6585         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()));
6586         check_added_monitors!(nodes[1], 1);
6587 }
6588
6589 #[test]
6590 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6591         //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
6592         let chanmon_cfgs = create_chanmon_cfgs(2);
6593         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6594         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6595         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6596         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6597         let logger = test_utils::TestLogger::new();
6598
6599         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6600         let channel_reserve = chan_stat.channel_reserve_msat;
6601         let feerate = get_feerate!(nodes[0], chan.2);
6602         // The 2* and +1 are for the fee spike reserve.
6603         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6604
6605         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6606         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6607         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6608         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();
6609         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6610         check_added_monitors!(nodes[0], 1);
6611         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6612
6613         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6614         // at this time channel-initiatee receivers are not required to enforce that senders
6615         // respect the fee_spike_reserve.
6616         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6617         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6618
6619         assert!(nodes[1].node.list_channels().is_empty());
6620         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6621         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6622         check_added_monitors!(nodes[1], 1);
6623 }
6624
6625 #[test]
6626 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6627         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6628         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6629         let chanmon_cfgs = create_chanmon_cfgs(2);
6630         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6631         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6632         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6633         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6634         let logger = test_utils::TestLogger::new();
6635
6636         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6637         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6638
6639         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6640         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();
6641
6642         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6643         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6644         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6645         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6646
6647         let mut msg = msgs::UpdateAddHTLC {
6648                 channel_id: chan.2,
6649                 htlc_id: 0,
6650                 amount_msat: 1000,
6651                 payment_hash: our_payment_hash,
6652                 cltv_expiry: htlc_cltv,
6653                 onion_routing_packet: onion_packet.clone(),
6654         };
6655
6656         for i in 0..super::channel::OUR_MAX_HTLCS {
6657                 msg.htlc_id = i as u64;
6658                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6659         }
6660         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6661         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6662
6663         assert!(nodes[1].node.list_channels().is_empty());
6664         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6665         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6666         check_added_monitors!(nodes[1], 1);
6667 }
6668
6669 #[test]
6670 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6671         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6672         let chanmon_cfgs = create_chanmon_cfgs(2);
6673         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6674         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6675         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6676         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6677         let logger = test_utils::TestLogger::new();
6678
6679         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6680         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6681         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6682         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6683         check_added_monitors!(nodes[0], 1);
6684         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6685         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).counterparty_max_htlc_value_in_flight_msat + 1;
6686         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6687
6688         assert!(nodes[1].node.list_channels().is_empty());
6689         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6690         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6691         check_added_monitors!(nodes[1], 1);
6692 }
6693
6694 #[test]
6695 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6696         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6697         let chanmon_cfgs = create_chanmon_cfgs(2);
6698         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6699         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6700         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6701         let logger = test_utils::TestLogger::new();
6702
6703         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6704         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6705         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6706         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();
6707         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6708         check_added_monitors!(nodes[0], 1);
6709         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6710         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6711         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6712
6713         assert!(nodes[1].node.list_channels().is_empty());
6714         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6715         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6716         check_added_monitors!(nodes[1], 1);
6717 }
6718
6719 #[test]
6720 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6721         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6722         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6723         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6724         let chanmon_cfgs = create_chanmon_cfgs(2);
6725         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6726         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6727         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6728         let logger = test_utils::TestLogger::new();
6729
6730         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6731         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6732         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6733         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();
6734         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6735         check_added_monitors!(nodes[0], 1);
6736         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6737         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6738
6739         //Disconnect and Reconnect
6740         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6741         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6742         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6743         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6744         assert_eq!(reestablish_1.len(), 1);
6745         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6746         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6747         assert_eq!(reestablish_2.len(), 1);
6748         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6749         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6750         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6751         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6752
6753         //Resend HTLC
6754         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6755         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6756         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6757         check_added_monitors!(nodes[1], 1);
6758         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6759
6760         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6761
6762         assert!(nodes[1].node.list_channels().is_empty());
6763         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6764         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6765         check_added_monitors!(nodes[1], 1);
6766 }
6767
6768 #[test]
6769 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6770         //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.
6771
6772         let chanmon_cfgs = create_chanmon_cfgs(2);
6773         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6774         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6775         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6776         let logger = test_utils::TestLogger::new();
6777         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6778         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6779         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6780         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();
6781         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6782
6783         check_added_monitors!(nodes[0], 1);
6784         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6785         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6786
6787         let update_msg = msgs::UpdateFulfillHTLC{
6788                 channel_id: chan.2,
6789                 htlc_id: 0,
6790                 payment_preimage: our_payment_preimage,
6791         };
6792
6793         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6794
6795         assert!(nodes[0].node.list_channels().is_empty());
6796         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6797         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()));
6798         check_added_monitors!(nodes[0], 1);
6799 }
6800
6801 #[test]
6802 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6803         //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.
6804
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(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6810         let logger = test_utils::TestLogger::new();
6811
6812         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6813         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6814         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();
6815         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6816         check_added_monitors!(nodes[0], 1);
6817         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6818         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6819
6820         let update_msg = msgs::UpdateFailHTLC{
6821                 channel_id: chan.2,
6822                 htlc_id: 0,
6823                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6824         };
6825
6826         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6827
6828         assert!(nodes[0].node.list_channels().is_empty());
6829         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6830         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()));
6831         check_added_monitors!(nodes[0], 1);
6832 }
6833
6834 #[test]
6835 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6836         //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.
6837
6838         let chanmon_cfgs = create_chanmon_cfgs(2);
6839         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6840         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6841         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6842         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6843         let logger = test_utils::TestLogger::new();
6844
6845         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6846         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6847         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();
6848         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6849         check_added_monitors!(nodes[0], 1);
6850         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6851         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6852
6853         let update_msg = msgs::UpdateFailMalformedHTLC{
6854                 channel_id: chan.2,
6855                 htlc_id: 0,
6856                 sha256_of_onion: [1; 32],
6857                 failure_code: 0x8000,
6858         };
6859
6860         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6861
6862         assert!(nodes[0].node.list_channels().is_empty());
6863         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6864         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()));
6865         check_added_monitors!(nodes[0], 1);
6866 }
6867
6868 #[test]
6869 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6870         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6871
6872         let chanmon_cfgs = create_chanmon_cfgs(2);
6873         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6874         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6875         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6876         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6877
6878         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6879
6880         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6881         check_added_monitors!(nodes[1], 1);
6882
6883         let events = nodes[1].node.get_and_clear_pending_msg_events();
6884         assert_eq!(events.len(), 1);
6885         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6886                 match events[0] {
6887                         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, .. } } => {
6888                                 assert!(update_add_htlcs.is_empty());
6889                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6890                                 assert!(update_fail_htlcs.is_empty());
6891                                 assert!(update_fail_malformed_htlcs.is_empty());
6892                                 assert!(update_fee.is_none());
6893                                 update_fulfill_htlcs[0].clone()
6894                         },
6895                         _ => panic!("Unexpected event"),
6896                 }
6897         };
6898
6899         update_fulfill_msg.htlc_id = 1;
6900
6901         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6902
6903         assert!(nodes[0].node.list_channels().is_empty());
6904         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6905         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6906         check_added_monitors!(nodes[0], 1);
6907 }
6908
6909 #[test]
6910 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6911         //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.
6912
6913         let chanmon_cfgs = create_chanmon_cfgs(2);
6914         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6915         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6916         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6917         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6918
6919         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6920
6921         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6922         check_added_monitors!(nodes[1], 1);
6923
6924         let events = nodes[1].node.get_and_clear_pending_msg_events();
6925         assert_eq!(events.len(), 1);
6926         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6927                 match events[0] {
6928                         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, .. } } => {
6929                                 assert!(update_add_htlcs.is_empty());
6930                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6931                                 assert!(update_fail_htlcs.is_empty());
6932                                 assert!(update_fail_malformed_htlcs.is_empty());
6933                                 assert!(update_fee.is_none());
6934                                 update_fulfill_htlcs[0].clone()
6935                         },
6936                         _ => panic!("Unexpected event"),
6937                 }
6938         };
6939
6940         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6941
6942         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6943
6944         assert!(nodes[0].node.list_channels().is_empty());
6945         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6946         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6947         check_added_monitors!(nodes[0], 1);
6948 }
6949
6950 #[test]
6951 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6952         //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.
6953
6954         let chanmon_cfgs = create_chanmon_cfgs(2);
6955         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6956         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6957         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6958         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6959         let logger = test_utils::TestLogger::new();
6960
6961         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6962         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6963         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();
6964         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6965         check_added_monitors!(nodes[0], 1);
6966
6967         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6968         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6969
6970         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6971         check_added_monitors!(nodes[1], 0);
6972         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6973
6974         let events = nodes[1].node.get_and_clear_pending_msg_events();
6975
6976         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6977                 match events[0] {
6978                         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, .. } } => {
6979                                 assert!(update_add_htlcs.is_empty());
6980                                 assert!(update_fulfill_htlcs.is_empty());
6981                                 assert!(update_fail_htlcs.is_empty());
6982                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6983                                 assert!(update_fee.is_none());
6984                                 update_fail_malformed_htlcs[0].clone()
6985                         },
6986                         _ => panic!("Unexpected event"),
6987                 }
6988         };
6989         update_msg.failure_code &= !0x8000;
6990         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6991
6992         assert!(nodes[0].node.list_channels().is_empty());
6993         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6994         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6995         check_added_monitors!(nodes[0], 1);
6996 }
6997
6998 #[test]
6999 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7000         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7001         //    * 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.
7002
7003         let chanmon_cfgs = create_chanmon_cfgs(3);
7004         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7005         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7006         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7007         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7008         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7009         let logger = test_utils::TestLogger::new();
7010
7011         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7012
7013         //First hop
7014         let mut payment_event = {
7015                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7016                 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();
7017                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7018                 check_added_monitors!(nodes[0], 1);
7019                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7020                 assert_eq!(events.len(), 1);
7021                 SendEvent::from_event(events.remove(0))
7022         };
7023         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7024         check_added_monitors!(nodes[1], 0);
7025         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7026         expect_pending_htlcs_forwardable!(nodes[1]);
7027         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7028         assert_eq!(events_2.len(), 1);
7029         check_added_monitors!(nodes[1], 1);
7030         payment_event = SendEvent::from_event(events_2.remove(0));
7031         assert_eq!(payment_event.msgs.len(), 1);
7032
7033         //Second Hop
7034         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7035         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7036         check_added_monitors!(nodes[2], 0);
7037         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7038
7039         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7040         assert_eq!(events_3.len(), 1);
7041         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7042                 match events_3[0] {
7043                         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 } } => {
7044                                 assert!(update_add_htlcs.is_empty());
7045                                 assert!(update_fulfill_htlcs.is_empty());
7046                                 assert!(update_fail_htlcs.is_empty());
7047                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7048                                 assert!(update_fee.is_none());
7049                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7050                         },
7051                         _ => panic!("Unexpected event"),
7052                 }
7053         };
7054
7055         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7056
7057         check_added_monitors!(nodes[1], 0);
7058         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7059         expect_pending_htlcs_forwardable!(nodes[1]);
7060         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7061         assert_eq!(events_4.len(), 1);
7062
7063         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7064         match events_4[0] {
7065                 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, .. } } => {
7066                         assert!(update_add_htlcs.is_empty());
7067                         assert!(update_fulfill_htlcs.is_empty());
7068                         assert_eq!(update_fail_htlcs.len(), 1);
7069                         assert!(update_fail_malformed_htlcs.is_empty());
7070                         assert!(update_fee.is_none());
7071                 },
7072                 _ => panic!("Unexpected event"),
7073         };
7074
7075         check_added_monitors!(nodes[1], 1);
7076 }
7077
7078 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7079         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7080         // 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
7081         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7082
7083         let chanmon_cfgs = create_chanmon_cfgs(2);
7084         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7085         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7086         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7087         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7088
7089         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7090
7091         // We route 2 dust-HTLCs between A and B
7092         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7093         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7094         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7095
7096         // Cache one local commitment tx as previous
7097         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7098
7099         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7100         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
7101         check_added_monitors!(nodes[1], 0);
7102         expect_pending_htlcs_forwardable!(nodes[1]);
7103         check_added_monitors!(nodes[1], 1);
7104
7105         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7106         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7107         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7108         check_added_monitors!(nodes[0], 1);
7109
7110         // Cache one local commitment tx as lastest
7111         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7112
7113         let events = nodes[0].node.get_and_clear_pending_msg_events();
7114         match events[0] {
7115                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7116                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7117                 },
7118                 _ => panic!("Unexpected event"),
7119         }
7120         match events[1] {
7121                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7122                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7123                 },
7124                 _ => panic!("Unexpected event"),
7125         }
7126
7127         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7128         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7129         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7130
7131         if announce_latest {
7132                 connect_block(&nodes[0], &Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
7133         } else {
7134                 connect_block(&nodes[0], &Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
7135         }
7136
7137         check_closed_broadcast!(nodes[0], false);
7138         check_added_monitors!(nodes[0], 1);
7139
7140         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7141         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 1, true,  header.block_hash());
7142         let events = nodes[0].node.get_and_clear_pending_events();
7143         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7144         assert_eq!(events.len(), 2);
7145         let mut first_failed = false;
7146         for event in events {
7147                 match event {
7148                         Event::PaymentFailed { payment_hash, .. } => {
7149                                 if payment_hash == payment_hash_1 {
7150                                         assert!(!first_failed);
7151                                         first_failed = true;
7152                                 } else {
7153                                         assert_eq!(payment_hash, payment_hash_2);
7154                                 }
7155                         }
7156                         _ => panic!("Unexpected event"),
7157                 }
7158         }
7159 }
7160
7161 #[test]
7162 fn test_failure_delay_dust_htlc_local_commitment() {
7163         do_test_failure_delay_dust_htlc_local_commitment(true);
7164         do_test_failure_delay_dust_htlc_local_commitment(false);
7165 }
7166
7167 #[test]
7168 fn test_no_failure_dust_htlc_local_commitment() {
7169         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
7170         // prone to error, we test here that a dummy transaction don't fail them.
7171
7172         let chanmon_cfgs = create_chanmon_cfgs(2);
7173         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7174         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7175         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7176         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7177
7178         // Rebalance a bit
7179         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7180
7181         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7182         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7183
7184         // We route 2 dust-HTLCs between A and B
7185         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7186         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
7187
7188         // Build a dummy invalid transaction trying to spend a commitment tx
7189         let input = TxIn {
7190                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
7191                 script_sig: Script::new(),
7192                 sequence: 0,
7193                 witness: Vec::new(),
7194         };
7195
7196         let outp = TxOut {
7197                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
7198                 value: 10000,
7199         };
7200
7201         let dummy_tx = Transaction {
7202                 version: 2,
7203                 lock_time: 0,
7204                 input: vec![input],
7205                 output: vec![outp]
7206         };
7207
7208         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7209         nodes[0].chain_monitor.chain_monitor.block_connected(&header, &[(0, &dummy_tx)], 1);
7210         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7211         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7212         // We broadcast a few more block to check everything is all right
7213         connect_blocks(&nodes[0], 20, 1, true, header.block_hash());
7214         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7215         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7216
7217         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
7218         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
7219 }
7220
7221 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7222         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7223         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7224         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7225         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7226         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7227         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7228
7229         let chanmon_cfgs = create_chanmon_cfgs(3);
7230         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7231         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7232         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7233         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7234
7235         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().holder_dust_limit_satoshis;
7236
7237         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7238         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7239
7240         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7241         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7242
7243         // We revoked bs_commitment_tx
7244         if revoked {
7245                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7246                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7247         }
7248
7249         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7250         let mut timeout_tx = Vec::new();
7251         if local {
7252                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7253                 connect_block(&nodes[0], &Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
7254                 check_closed_broadcast!(nodes[0], false);
7255                 check_added_monitors!(nodes[0], 1);
7256                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7257                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7258                 let parent_hash  = connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 2, true, header.block_hash());
7259                 expect_payment_failed!(nodes[0], dust_hash, true);
7260                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7261                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7262                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7263                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7264                 connect_block(&nodes[0], &Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7265                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7266                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 8, true, header_3.block_hash());
7267                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7268         } else {
7269                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7270                 connect_block(&nodes[0], &Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
7271                 check_closed_broadcast!(nodes[0], false);
7272                 check_added_monitors!(nodes[0], 1);
7273                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7274                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7275                 let parent_hash  = connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 2, true, header.block_hash());
7276                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7277                 if !revoked {
7278                         expect_payment_failed!(nodes[0], dust_hash, true);
7279                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7280                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7281                         connect_block(&nodes[0], &Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7282                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7283                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7284                         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 8, true, header_3.block_hash());
7285                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7286                 } else {
7287                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7288                         // commitment tx
7289                         let events = nodes[0].node.get_and_clear_pending_events();
7290                         assert_eq!(events.len(), 2);
7291                         let first;
7292                         match events[0] {
7293                                 Event::PaymentFailed { payment_hash, .. } => {
7294                                         if payment_hash == dust_hash { first = true; }
7295                                         else { first = false; }
7296                                 },
7297                                 _ => panic!("Unexpected event"),
7298                         }
7299                         match events[1] {
7300                                 Event::PaymentFailed { payment_hash, .. } => {
7301                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7302                                         else { assert_eq!(payment_hash, dust_hash); }
7303                                 },
7304                                 _ => panic!("Unexpected event"),
7305                         }
7306                 }
7307         }
7308 }
7309
7310 #[test]
7311 fn test_sweep_outbound_htlc_failure_update() {
7312         do_test_sweep_outbound_htlc_failure_update(false, true);
7313         do_test_sweep_outbound_htlc_failure_update(false, false);
7314         do_test_sweep_outbound_htlc_failure_update(true, false);
7315 }
7316
7317 #[test]
7318 fn test_upfront_shutdown_script() {
7319         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7320         // enforce it at shutdown message
7321
7322         let mut config = UserConfig::default();
7323         config.channel_options.announced_channel = true;
7324         config.peer_channel_config_limits.force_announced_channel_preference = false;
7325         config.channel_options.commit_upfront_shutdown_pubkey = false;
7326         let user_cfgs = [None, Some(config), None];
7327         let chanmon_cfgs = create_chanmon_cfgs(3);
7328         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7329         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7330         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7331
7332         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7333         let flags = InitFeatures::known();
7334         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7335         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7336         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7337         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7338         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7339         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7340     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()));
7341         check_added_monitors!(nodes[2], 1);
7342
7343         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7344         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7345         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7346         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7347         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7348         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7349         let events = nodes[2].node.get_and_clear_pending_msg_events();
7350         assert_eq!(events.len(), 1);
7351         match events[0] {
7352                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7353                 _ => panic!("Unexpected event"),
7354         }
7355
7356         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7357         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7358         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7359         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7360         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7361         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7362         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
7363         let events = nodes[1].node.get_and_clear_pending_msg_events();
7364         assert_eq!(events.len(), 1);
7365         match events[0] {
7366                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7367                 _ => panic!("Unexpected event"),
7368         }
7369
7370         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7371         // channel smoothly, opt-out is from channel initiator here
7372         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7373         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7374         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7375         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7376         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7377         let events = nodes[0].node.get_and_clear_pending_msg_events();
7378         assert_eq!(events.len(), 1);
7379         match events[0] {
7380                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7381                 _ => panic!("Unexpected event"),
7382         }
7383
7384         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7385         //// channel smoothly
7386         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7387         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7388         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7389         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7390         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7391         let events = nodes[0].node.get_and_clear_pending_msg_events();
7392         assert_eq!(events.len(), 2);
7393         match events[0] {
7394                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7395                 _ => panic!("Unexpected event"),
7396         }
7397         match events[1] {
7398                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7399                 _ => panic!("Unexpected event"),
7400         }
7401 }
7402
7403 #[test]
7404 fn test_user_configurable_csv_delay() {
7405         // We test our channel constructors yield errors when we pass them absurd csv delay
7406
7407         let mut low_our_to_self_config = UserConfig::default();
7408         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7409         let mut high_their_to_self_config = UserConfig::default();
7410         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7411         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7412         let chanmon_cfgs = create_chanmon_cfgs(2);
7413         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7414         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7415         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7416
7417         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7418         let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet));
7419         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) {
7420                 match error {
7421                         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())); },
7422                         _ => panic!("Unexpected event"),
7423                 }
7424         } else { assert!(false) }
7425
7426         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7427         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7428         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7429         open_channel.to_self_delay = 200;
7430         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) {
7431                 match error {
7432                         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()));  },
7433                         _ => panic!("Unexpected event"),
7434                 }
7435         } else { assert!(false); }
7436
7437         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7438         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7439         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()));
7440         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7441         accept_channel.to_self_delay = 200;
7442         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7443         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7444                 match action {
7445                         &ErrorAction::SendErrorMessage { ref msg } => {
7446                                 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()));
7447                         },
7448                         _ => { assert!(false); }
7449                 }
7450         } else { assert!(false); }
7451
7452         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7453         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7454         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7455         open_channel.to_self_delay = 200;
7456         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) {
7457                 match error {
7458                         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())); },
7459                         _ => panic!("Unexpected event"),
7460                 }
7461         } else { assert!(false); }
7462 }
7463
7464 #[test]
7465 fn test_data_loss_protect() {
7466         // We want to be sure that :
7467         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7468         // * we close channel in case of detecting other being fallen behind
7469         // * we are able to claim our own outputs thanks to to_remote being static
7470         let keys_manager;
7471         let logger;
7472         let fee_estimator;
7473         let tx_broadcaster;
7474         let chain_source;
7475         let monitor;
7476         let node_state_0;
7477         let chanmon_cfgs = create_chanmon_cfgs(2);
7478         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7479         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7480         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7481
7482         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7483
7484         // Cache node A state before any channel update
7485         let previous_node_state = nodes[0].node.encode();
7486         let mut previous_chain_monitor_state = test_utils::TestVecWriter(Vec::new());
7487         nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chain_monitor_state).unwrap();
7488
7489         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7490         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7491
7492         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7493         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7494
7495         // Restore node A from previous state
7496         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7497         let mut chain_monitor = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chain_monitor_state.0)).unwrap().1;
7498         chain_source = test_utils::TestChainSource::new(Network::Testnet);
7499         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7500         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7501         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
7502         monitor = test_utils::TestChainMonitor::new(&tx_broadcaster, &logger, &fee_estimator);
7503         node_state_0 = {
7504                 let mut channel_monitors = HashMap::new();
7505                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chain_monitor);
7506                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7507                         keys_manager: &keys_manager,
7508                         fee_estimator: &fee_estimator,
7509                         chain_monitor: &monitor,
7510                         logger: &logger,
7511                         tx_broadcaster: &tx_broadcaster,
7512                         default_config: UserConfig::default(),
7513                         channel_monitors,
7514                 }).unwrap().1
7515         };
7516         nodes[0].node = &node_state_0;
7517         assert!(monitor.watch_channel(OutPoint { txid: chan.3.txid(), index: 0 }, chain_monitor).is_ok());
7518         nodes[0].chain_monitor = &monitor;
7519         nodes[0].chain_source = &chain_source;
7520
7521         nodes[0].block_notifier = BlockNotifier::new();
7522         nodes[0].block_notifier.register_listener(&nodes[0].chain_monitor.chain_monitor);
7523         nodes[0].block_notifier.register_listener(nodes[0].node);
7524
7525         check_added_monitors!(nodes[0], 1);
7526
7527         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7528         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7529
7530         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7531
7532         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7533         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7534         check_added_monitors!(nodes[0], 1);
7535
7536         {
7537                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7538                 assert_eq!(node_txn.len(), 0);
7539         }
7540
7541         let mut reestablish_1 = Vec::with_capacity(1);
7542         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7543                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7544                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7545                         reestablish_1.push(msg.clone());
7546                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7547                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7548                         match action {
7549                                 &ErrorAction::SendErrorMessage { ref msg } => {
7550                                         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");
7551                                 },
7552                                 _ => panic!("Unexpected event!"),
7553                         }
7554                 } else {
7555                         panic!("Unexpected event")
7556                 }
7557         }
7558
7559         // Check we close channel detecting A is fallen-behind
7560         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7561         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7562         check_added_monitors!(nodes[1], 1);
7563
7564
7565         // Check A is able to claim to_remote output
7566         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7567         assert_eq!(node_txn.len(), 1);
7568         check_spends!(node_txn[0], chan.3);
7569         assert_eq!(node_txn[0].output.len(), 2);
7570         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
7571         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[0].clone()]}, 0);
7572         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1, 0, true, header.block_hash());
7573         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
7574         assert_eq!(spend_txn.len(), 1);
7575         check_spends!(spend_txn[0], node_txn[0]);
7576 }
7577
7578 #[test]
7579 fn test_check_htlc_underpaying() {
7580         // Send payment through A -> B but A is maliciously
7581         // sending a probe payment (i.e less than expected value0
7582         // to B, B should refuse payment.
7583
7584         let chanmon_cfgs = create_chanmon_cfgs(2);
7585         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7586         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7587         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7588
7589         // Create some initial channels
7590         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7591
7592         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7593
7594         // Node 3 is expecting payment of 100_000 but receive 10_000,
7595         // fail htlc like we didn't know the preimage.
7596         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7597         nodes[1].node.process_pending_htlc_forwards();
7598
7599         let events = nodes[1].node.get_and_clear_pending_msg_events();
7600         assert_eq!(events.len(), 1);
7601         let (update_fail_htlc, commitment_signed) = match events[0] {
7602                 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 } } => {
7603                         assert!(update_add_htlcs.is_empty());
7604                         assert!(update_fulfill_htlcs.is_empty());
7605                         assert_eq!(update_fail_htlcs.len(), 1);
7606                         assert!(update_fail_malformed_htlcs.is_empty());
7607                         assert!(update_fee.is_none());
7608                         (update_fail_htlcs[0].clone(), commitment_signed)
7609                 },
7610                 _ => panic!("Unexpected event"),
7611         };
7612         check_added_monitors!(nodes[1], 1);
7613
7614         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7615         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7616
7617         // 10_000 msat as u64, followed by a height of 99 as u32
7618         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7619         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(99));
7620         expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7621         nodes[1].node.get_and_clear_pending_events();
7622 }
7623
7624 #[test]
7625 fn test_announce_disable_channels() {
7626         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
7627         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7628
7629         let chanmon_cfgs = create_chanmon_cfgs(2);
7630         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7631         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7632         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7633
7634         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7635         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7636         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7637
7638         // Disconnect peers
7639         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7640         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7641
7642         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7643         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7644         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7645         assert_eq!(msg_events.len(), 3);
7646         for e in msg_events {
7647                 match e {
7648                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7649                                 let short_id = msg.contents.short_channel_id;
7650                                 // Check generated channel_update match list in PendingChannelUpdate
7651                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7652                                         panic!("Generated ChannelUpdate for wrong chan!");
7653                                 }
7654                         },
7655                         _ => panic!("Unexpected event"),
7656                 }
7657         }
7658         // Reconnect peers
7659         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7660         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7661         assert_eq!(reestablish_1.len(), 3);
7662         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7663         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7664         assert_eq!(reestablish_2.len(), 3);
7665
7666         // Reestablish chan_1
7667         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7668         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7669         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7670         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7671         // Reestablish chan_2
7672         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7673         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7674         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7675         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7676         // Reestablish chan_3
7677         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7678         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7679         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7680         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7681
7682         nodes[0].node.timer_chan_freshness_every_min();
7683         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7684 }
7685
7686 #[test]
7687 fn test_bump_penalty_txn_on_revoked_commitment() {
7688         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7689         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7690
7691         let chanmon_cfgs = create_chanmon_cfgs(2);
7692         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7693         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7694         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7695
7696         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7697         let logger = test_utils::TestLogger::new();
7698
7699
7700         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7701         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7702         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();
7703         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7704
7705         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7706         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7707         assert_eq!(revoked_txn[0].output.len(), 4);
7708         assert_eq!(revoked_txn[0].input.len(), 1);
7709         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7710         let revoked_txid = revoked_txn[0].txid();
7711
7712         let mut penalty_sum = 0;
7713         for outp in revoked_txn[0].output.iter() {
7714                 if outp.script_pubkey.is_v0_p2wsh() {
7715                         penalty_sum += outp.value;
7716                 }
7717         }
7718
7719         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7720         let header_114 = connect_blocks(&nodes[1], 114, 0, false, Default::default());
7721
7722         // Actually revoke tx by claiming a HTLC
7723         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7724         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7725         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7726         check_added_monitors!(nodes[1], 1);
7727
7728         // One or more justice tx should have been broadcast, check it
7729         let penalty_1;
7730         let feerate_1;
7731         {
7732                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7733                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7734                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7735                 assert_eq!(node_txn[0].output.len(), 1);
7736                 check_spends!(node_txn[0], revoked_txn[0]);
7737                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7738                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7739                 penalty_1 = node_txn[0].txid();
7740                 node_txn.clear();
7741         };
7742
7743         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7744         let header = connect_blocks(&nodes[1], 3, 115,  true, header.block_hash());
7745         let mut penalty_2 = penalty_1;
7746         let mut feerate_2 = 0;
7747         {
7748                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7749                 assert_eq!(node_txn.len(), 1);
7750                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7751                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7752                         assert_eq!(node_txn[0].output.len(), 1);
7753                         check_spends!(node_txn[0], revoked_txn[0]);
7754                         penalty_2 = node_txn[0].txid();
7755                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7756                         assert_ne!(penalty_2, penalty_1);
7757                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7758                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7759                         // Verify 25% bump heuristic
7760                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7761                         node_txn.clear();
7762                 }
7763         }
7764         assert_ne!(feerate_2, 0);
7765
7766         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7767         connect_blocks(&nodes[1], 3, 118, true, header);
7768         let penalty_3;
7769         let mut feerate_3 = 0;
7770         {
7771                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7772                 assert_eq!(node_txn.len(), 1);
7773                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7774                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7775                         assert_eq!(node_txn[0].output.len(), 1);
7776                         check_spends!(node_txn[0], revoked_txn[0]);
7777                         penalty_3 = node_txn[0].txid();
7778                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7779                         assert_ne!(penalty_3, penalty_2);
7780                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7781                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7782                         // Verify 25% bump heuristic
7783                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7784                         node_txn.clear();
7785                 }
7786         }
7787         assert_ne!(feerate_3, 0);
7788
7789         nodes[1].node.get_and_clear_pending_events();
7790         nodes[1].node.get_and_clear_pending_msg_events();
7791 }
7792
7793 #[test]
7794 fn test_bump_penalty_txn_on_revoked_htlcs() {
7795         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7796         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7797
7798         let chanmon_cfgs = create_chanmon_cfgs(2);
7799         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7800         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7801         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7802
7803         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7804         // Lock HTLC in both directions
7805         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7806         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7807
7808         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7809         assert_eq!(revoked_local_txn[0].input.len(), 1);
7810         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7811
7812         // Revoke local commitment tx
7813         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7814
7815         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7816         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7817         connect_block(&nodes[1], &Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7818         check_closed_broadcast!(nodes[1], false);
7819         check_added_monitors!(nodes[1], 1);
7820
7821         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7822         assert_eq!(revoked_htlc_txn.len(), 4);
7823         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7824                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7825                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7826                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7827                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7828                 assert_eq!(revoked_htlc_txn[1].output.len(), 1);
7829                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7830         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7831                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7832                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7833                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7834                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7835                 assert_eq!(revoked_htlc_txn[0].output.len(), 1);
7836                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7837         }
7838
7839         // Broadcast set of revoked txn on A
7840         let header_128 = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7841         connect_block(&nodes[0], &Block { header: header_128, txdata: vec![revoked_local_txn[0].clone()] }, 128);
7842         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7843         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7844         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
7845         let first;
7846         let feerate_1;
7847         let penalty_txn;
7848         {
7849                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7850                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7851                 // Verify claim tx are spending revoked HTLC txn
7852
7853                 // node_txn 0-2 each spend a separate revoked output from revoked_local_txn[0]
7854                 // Note that node_txn[0] and node_txn[1] are bogus - they double spend the revoked_htlc_txn
7855                 // which are included in the same block (they are broadcasted because we scan the
7856                 // transactions linearly and generate claims as we go, they likely should be removed in the
7857                 // future).
7858                 assert_eq!(node_txn[0].input.len(), 1);
7859                 check_spends!(node_txn[0], revoked_local_txn[0]);
7860                 assert_eq!(node_txn[1].input.len(), 1);
7861                 check_spends!(node_txn[1], revoked_local_txn[0]);
7862                 assert_eq!(node_txn[2].input.len(), 1);
7863                 check_spends!(node_txn[2], revoked_local_txn[0]);
7864
7865                 // Each of the three justice transactions claim a separate (single) output of the three
7866                 // available, which we check here:
7867                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[1].input[0].previous_output);
7868                 assert_ne!(node_txn[0].input[0].previous_output, node_txn[2].input[0].previous_output);
7869                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
7870
7871                 assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7872                 assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7873
7874                 // node_txn[3] is the local commitment tx broadcast just because (and somewhat in case of
7875                 // reorgs, though its not clear its ever worth broadcasting conflicting txn like this when
7876                 // a remote commitment tx has already been confirmed).
7877                 check_spends!(node_txn[3], chan.3);
7878
7879                 // node_txn[4] spends the revoked outputs from the revoked_htlc_txn (which only have one
7880                 // output, checked above).
7881                 assert_eq!(node_txn[4].input.len(), 2);
7882                 assert_eq!(node_txn[4].output.len(), 1);
7883                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7884
7885                 first = node_txn[4].txid();
7886                 // Store both feerates for later comparison
7887                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7888                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7889                 penalty_txn = vec![node_txn[2].clone()];
7890                 node_txn.clear();
7891         }
7892
7893         // Connect one more block to see if bumped penalty are issued for HTLC txn
7894         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7895         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, 130);
7896         let header_131 = BlockHeader { version: 0x20000000, prev_blockhash: header_130.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7897         connect_block(&nodes[0], &Block { header: header_131, txdata: Vec::new() }, 131);
7898         {
7899                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7900                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7901
7902                 check_spends!(node_txn[0], revoked_local_txn[0]);
7903                 check_spends!(node_txn[1], revoked_local_txn[0]);
7904                 // Note that these are both bogus - they spend outputs already claimed in block 129:
7905                 if node_txn[0].input[0].previous_output == revoked_htlc_txn[0].input[0].previous_output  {
7906                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7907                 } else {
7908                         assert_eq!(node_txn[0].input[0].previous_output, revoked_htlc_txn[1].input[0].previous_output);
7909                         assert_eq!(node_txn[1].input[0].previous_output, revoked_htlc_txn[0].input[0].previous_output);
7910                 }
7911
7912                 node_txn.clear();
7913         };
7914
7915         // Few more blocks to confirm penalty txn
7916         let header_135 = connect_blocks(&nodes[0], 4, 131, true, header_131.block_hash());
7917         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7918         let header_144 = connect_blocks(&nodes[0], 9, 135, true, header_135);
7919         let node_txn = {
7920                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7921                 assert_eq!(node_txn.len(), 1);
7922
7923                 assert_eq!(node_txn[0].input.len(), 2);
7924                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7925                 // Verify bumped tx is different and 25% bump heuristic
7926                 assert_ne!(first, node_txn[0].txid());
7927                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7928                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7929                 assert!(feerate_2 * 100 > feerate_1 * 125);
7930                 let txn = vec![node_txn[0].clone()];
7931                 node_txn.clear();
7932                 txn
7933         };
7934         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7935         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7936         connect_block(&nodes[0], &Block { header: header_145, txdata: node_txn }, 145);
7937         connect_blocks(&nodes[0], 20, 145, true, header_145.block_hash());
7938         {
7939                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7940                 // We verify than no new transaction has been broadcast because previously
7941                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7942                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7943                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7944                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7945                 // up bumped justice generation.
7946                 assert_eq!(node_txn.len(), 0);
7947                 node_txn.clear();
7948         }
7949         check_closed_broadcast!(nodes[0], false);
7950         check_added_monitors!(nodes[0], 1);
7951 }
7952
7953 #[test]
7954 fn test_bump_penalty_txn_on_remote_commitment() {
7955         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7956         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7957
7958         // Create 2 HTLCs
7959         // Provide preimage for one
7960         // Check aggregation
7961
7962         let chanmon_cfgs = create_chanmon_cfgs(2);
7963         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7964         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7965         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7966
7967         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7968         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7969         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7970
7971         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7972         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7973         assert_eq!(remote_txn[0].output.len(), 4);
7974         assert_eq!(remote_txn[0].input.len(), 1);
7975         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7976
7977         // Claim a HTLC without revocation (provide B monitor with preimage)
7978         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7979         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7980         connect_block(&nodes[1], &Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7981         check_added_monitors!(nodes[1], 2);
7982
7983         // One or more claim tx should have been broadcast, check it
7984         let timeout;
7985         let preimage;
7986         let feerate_timeout;
7987         let feerate_preimage;
7988         {
7989                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7990                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7991                 assert_eq!(node_txn[0].input.len(), 1);
7992                 assert_eq!(node_txn[1].input.len(), 1);
7993                 check_spends!(node_txn[0], remote_txn[0]);
7994                 check_spends!(node_txn[1], remote_txn[0]);
7995                 check_spends!(node_txn[2], chan.3);
7996                 check_spends!(node_txn[3], node_txn[2]);
7997                 check_spends!(node_txn[4], node_txn[2]);
7998                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7999                         timeout = node_txn[0].txid();
8000                         let index = node_txn[0].input[0].previous_output.vout;
8001                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8002                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
8003
8004                         preimage = node_txn[1].txid();
8005                         let index = node_txn[1].input[0].previous_output.vout;
8006                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8007                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
8008                 } else {
8009                         timeout = node_txn[1].txid();
8010                         let index = node_txn[1].input[0].previous_output.vout;
8011                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8012                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
8013
8014                         preimage = node_txn[0].txid();
8015                         let index = node_txn[0].input[0].previous_output.vout;
8016                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8017                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8018                 }
8019                 node_txn.clear();
8020         };
8021         assert_ne!(feerate_timeout, 0);
8022         assert_ne!(feerate_preimage, 0);
8023
8024         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8025         connect_blocks(&nodes[1], 15, 1,  true, header.block_hash());
8026         {
8027                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8028                 assert_eq!(node_txn.len(), 2);
8029                 assert_eq!(node_txn[0].input.len(), 1);
8030                 assert_eq!(node_txn[1].input.len(), 1);
8031                 check_spends!(node_txn[0], remote_txn[0]);
8032                 check_spends!(node_txn[1], remote_txn[0]);
8033                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8034                         let index = node_txn[0].input[0].previous_output.vout;
8035                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8036                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8037                         assert!(new_feerate * 100 > feerate_timeout * 125);
8038                         assert_ne!(timeout, node_txn[0].txid());
8039
8040                         let index = node_txn[1].input[0].previous_output.vout;
8041                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8042                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8043                         assert!(new_feerate * 100 > feerate_preimage * 125);
8044                         assert_ne!(preimage, node_txn[1].txid());
8045                 } else {
8046                         let index = node_txn[1].input[0].previous_output.vout;
8047                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8048                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8049                         assert!(new_feerate * 100 > feerate_timeout * 125);
8050                         assert_ne!(timeout, node_txn[1].txid());
8051
8052                         let index = node_txn[0].input[0].previous_output.vout;
8053                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8054                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8055                         assert!(new_feerate * 100 > feerate_preimage * 125);
8056                         assert_ne!(preimage, node_txn[0].txid());
8057                 }
8058                 node_txn.clear();
8059         }
8060
8061         nodes[1].node.get_and_clear_pending_events();
8062         nodes[1].node.get_and_clear_pending_msg_events();
8063 }
8064
8065 #[test]
8066 fn test_set_outpoints_partial_claiming() {
8067         // - remote party claim tx, new bump tx
8068         // - disconnect remote claiming tx, new bump
8069         // - disconnect tx, see no tx anymore
8070         let chanmon_cfgs = create_chanmon_cfgs(2);
8071         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8072         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8073         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8074
8075         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8076         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8077         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8078
8079         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
8080         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
8081         assert_eq!(remote_txn.len(), 3);
8082         assert_eq!(remote_txn[0].output.len(), 4);
8083         assert_eq!(remote_txn[0].input.len(), 1);
8084         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8085         check_spends!(remote_txn[1], remote_txn[0]);
8086         check_spends!(remote_txn[2], remote_txn[0]);
8087
8088         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
8089         let prev_header_100 = connect_blocks(&nodes[1], 100, 0, false, Default::default());
8090         // Provide node A with both preimage
8091         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
8092         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
8093         check_added_monitors!(nodes[0], 2);
8094         nodes[0].node.get_and_clear_pending_events();
8095         nodes[0].node.get_and_clear_pending_msg_events();
8096
8097         // Connect blocks on node A commitment transaction
8098         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8099         connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
8100         check_closed_broadcast!(nodes[0], false);
8101         check_added_monitors!(nodes[0], 1);
8102         // Verify node A broadcast tx claiming both HTLCs
8103         {
8104                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8105                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
8106                 assert_eq!(node_txn.len(), 4);
8107                 check_spends!(node_txn[0], remote_txn[0]);
8108                 check_spends!(node_txn[1], chan.3);
8109                 check_spends!(node_txn[2], node_txn[1]);
8110                 check_spends!(node_txn[3], node_txn[1]);
8111                 assert_eq!(node_txn[0].input.len(), 2);
8112                 node_txn.clear();
8113         }
8114
8115         // Connect blocks on node B
8116         connect_blocks(&nodes[1], 135, 0, false, Default::default());
8117         check_closed_broadcast!(nodes[1], false);
8118         check_added_monitors!(nodes[1], 1);
8119         // Verify node B broadcast 2 HTLC-timeout txn
8120         let partial_claim_tx = {
8121                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8122                 assert_eq!(node_txn.len(), 3);
8123                 check_spends!(node_txn[1], node_txn[0]);
8124                 check_spends!(node_txn[2], node_txn[0]);
8125                 assert_eq!(node_txn[1].input.len(), 1);
8126                 assert_eq!(node_txn[2].input.len(), 1);
8127                 node_txn[1].clone()
8128         };
8129
8130         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
8131         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8132         connect_block(&nodes[0], &Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
8133         {
8134                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8135                 assert_eq!(node_txn.len(), 1);
8136                 check_spends!(node_txn[0], remote_txn[0]);
8137                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
8138                 node_txn.clear();
8139         }
8140         nodes[0].node.get_and_clear_pending_msg_events();
8141
8142         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
8143         disconnect_block(&nodes[0], &header, 102);
8144         {
8145                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8146                 assert_eq!(node_txn.len(), 1);
8147                 check_spends!(node_txn[0], remote_txn[0]);
8148                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
8149                 node_txn.clear();
8150         }
8151
8152         //// Disconnect one more block and then reconnect multiple no transaction should be generated
8153         disconnect_block(&nodes[0], &header, 101);
8154         connect_blocks(&nodes[1], 15, 101, false, prev_header_100);
8155         {
8156                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8157                 assert_eq!(node_txn.len(), 0);
8158                 node_txn.clear();
8159         }
8160 }
8161
8162 #[test]
8163 fn test_counterparty_raa_skip_no_crash() {
8164         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8165         // commitment transaction, we would have happily carried on and provided them the next
8166         // commitment transaction based on one RAA forward. This would probably eventually have led to
8167         // channel closure, but it would not have resulted in funds loss. Still, our
8168         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
8169         // check simply that the channel is closed in response to such an RAA, but don't check whether
8170         // we decide to punish our counterparty for revoking their funds (as we don't currently
8171         // implement that).
8172         let chanmon_cfgs = create_chanmon_cfgs(2);
8173         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8174         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8175         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8176         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8177
8178         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8179         let keys = &guard.by_id.get_mut(&channel_id).unwrap().holder_keys;
8180         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8181         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8182                 &SecretKey::from_slice(&keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8183         let per_commitment_secret = keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8184
8185         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8186                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8187         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8188         check_added_monitors!(nodes[1], 1);
8189 }
8190
8191 #[test]
8192 fn test_bump_txn_sanitize_tracking_maps() {
8193         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8194         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8195
8196         let chanmon_cfgs = create_chanmon_cfgs(2);
8197         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8198         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8199         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8200
8201         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8202         // Lock HTLC in both directions
8203         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8204         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8205
8206         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8207         assert_eq!(revoked_local_txn[0].input.len(), 1);
8208         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8209
8210         // Revoke local commitment tx
8211         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8212
8213         // Broadcast set of revoked txn on A
8214         let header_128 = connect_blocks(&nodes[0], 128, 0,  false, Default::default());
8215         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8216
8217         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8218         connect_block(&nodes[0], &Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
8219         check_closed_broadcast!(nodes[0], false);
8220         check_added_monitors!(nodes[0], 1);
8221         let penalty_txn = {
8222                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8223                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8224                 check_spends!(node_txn[0], revoked_local_txn[0]);
8225                 check_spends!(node_txn[1], revoked_local_txn[0]);
8226                 check_spends!(node_txn[2], revoked_local_txn[0]);
8227                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8228                 node_txn.clear();
8229                 penalty_txn
8230         };
8231         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8232         connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn }, 130);
8233         connect_blocks(&nodes[0], 5, 130,  false, header_130.block_hash());
8234         {
8235                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8236                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8237                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
8238                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
8239                 }
8240         }
8241 }
8242
8243 #[test]
8244 fn test_override_channel_config() {
8245         let chanmon_cfgs = create_chanmon_cfgs(2);
8246         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8247         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8248         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8249
8250         // Node0 initiates a channel to node1 using the override config.
8251         let mut override_config = UserConfig::default();
8252         override_config.own_channel_config.our_to_self_delay = 200;
8253
8254         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8255
8256         // Assert the channel created by node0 is using the override config.
8257         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8258         assert_eq!(res.channel_flags, 0);
8259         assert_eq!(res.to_self_delay, 200);
8260 }
8261
8262 #[test]
8263 fn test_override_0msat_htlc_minimum() {
8264         let mut zero_config = UserConfig::default();
8265         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8266         let chanmon_cfgs = create_chanmon_cfgs(2);
8267         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8268         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8269         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8270
8271         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8272         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8273         assert_eq!(res.htlc_minimum_msat, 1);
8274
8275         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8276         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8277         assert_eq!(res.htlc_minimum_msat, 1);
8278 }
8279
8280 #[test]
8281 fn test_simple_payment_secret() {
8282         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8283         // features, however.
8284         let chanmon_cfgs = create_chanmon_cfgs(3);
8285         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8286         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8287         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8288
8289         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8290         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8291         let logger = test_utils::TestLogger::new();
8292
8293         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8294         let payment_secret = PaymentSecret([0xdb; 32]);
8295         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8296         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();
8297         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8298         // Claiming with all the correct values but the wrong secret should result in nothing...
8299         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8300         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8301         // ...but with the right secret we should be able to claim all the way back
8302         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8303 }
8304
8305 #[test]
8306 fn test_simple_mpp() {
8307         // Simple test of sending a multi-path payment.
8308         let chanmon_cfgs = create_chanmon_cfgs(4);
8309         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8310         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8311         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8312
8313         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8314         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8315         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8316         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8317         let logger = test_utils::TestLogger::new();
8318
8319         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8320         let payment_secret = PaymentSecret([0xdb; 32]);
8321         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8322         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();
8323         let path = route.paths[0].clone();
8324         route.paths.push(path);
8325         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8326         route.paths[0][0].short_channel_id = chan_1_id;
8327         route.paths[0][1].short_channel_id = chan_3_id;
8328         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8329         route.paths[1][0].short_channel_id = chan_2_id;
8330         route.paths[1][1].short_channel_id = chan_4_id;
8331         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8332         // Claiming with all the correct values but the wrong secret should result in nothing...
8333         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8334         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8335         // ...but with the right secret we should be able to claim all the way back
8336         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8337 }
8338
8339 #[test]
8340 fn test_update_err_monitor_lockdown() {
8341         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8342         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8343         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8344         //
8345         // This scenario may happen in a watchtower setup, where watchtower process a block height
8346         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8347         // commitment at same time.
8348
8349         let chanmon_cfgs = create_chanmon_cfgs(2);
8350         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8351         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8352         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8353
8354         // Create some initial channel
8355         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8356         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8357
8358         // Rebalance the network to generate htlc in the two directions
8359         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8360
8361         // Route a HTLC from node 0 to node 1 (but don't settle)
8362         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8363
8364         // Copy ChainMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8365         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8366         let watchtower = {
8367                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8368                 let monitor = monitors.get(&outpoint).unwrap();
8369                 let mut w = test_utils::TestVecWriter(Vec::new());
8370                 monitor.write_for_disk(&mut w).unwrap();
8371                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8372                                 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
8373                 assert!(new_monitor == *monitor);
8374                 let watchtower = test_utils::TestChainMonitor::new(&chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator);
8375                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8376                 watchtower
8377         };
8378         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8379         watchtower.chain_monitor.block_connected(&header, &[], 200);
8380
8381         // Try to update ChannelMonitor
8382         assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8383         check_added_monitors!(nodes[1], 1);
8384         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8385         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8386         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8387         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8388                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8389                         if let Err(_) =  watchtower.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8390                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8391                 } else { assert!(false); }
8392         } else { assert!(false); };
8393         // Our local monitor is in-sync and hasn't processed yet timeout
8394         check_added_monitors!(nodes[0], 1);
8395         let events = nodes[0].node.get_and_clear_pending_events();
8396         assert_eq!(events.len(), 1);
8397 }
8398
8399 #[test]
8400 fn test_concurrent_monitor_claim() {
8401         // Watchtower A receives block, broadcasts state N, then channel receives new state N+1,
8402         // sending it to both watchtowers, Bob accepts N+1, then receives block and broadcasts
8403         // the latest state N+1, Alice rejects state N+1, but Bob has already broadcast it,
8404         // state N+1 confirms. Alice claims output from state N+1.
8405
8406         let chanmon_cfgs = create_chanmon_cfgs(2);
8407         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8408         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8409         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8410
8411         // Create some initial channel
8412         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8413         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8414
8415         // Rebalance the network to generate htlc in the two directions
8416         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8417
8418         // Route a HTLC from node 0 to node 1 (but don't settle)
8419         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8420
8421         // Copy ChainMonitor to simulate watchtower Alice and update block height her ChannelMonitor timeout HTLC onchain
8422         let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
8423         let watchtower_alice = {
8424                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8425                 let monitor = monitors.get(&outpoint).unwrap();
8426                 let mut w = test_utils::TestVecWriter(Vec::new());
8427                 monitor.write_for_disk(&mut w).unwrap();
8428                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8429                                 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
8430                 assert!(new_monitor == *monitor);
8431                 let watchtower = test_utils::TestChainMonitor::new(&chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator);
8432                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8433                 watchtower
8434         };
8435         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8436         watchtower_alice.chain_monitor.block_connected(&header, &vec![], 135);
8437
8438         // Watchtower Alice should have broadcast a commitment/HTLC-timeout
8439         {
8440                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8441                 assert_eq!(txn.len(), 2);
8442                 txn.clear();
8443         }
8444
8445         // Copy ChainMonitor to simulate watchtower Bob and make it receive a commitment update first.
8446         let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
8447         let watchtower_bob = {
8448                 let monitors = nodes[0].chain_monitor.chain_monitor.monitors.lock().unwrap();
8449                 let monitor = monitors.get(&outpoint).unwrap();
8450                 let mut w = test_utils::TestVecWriter(Vec::new());
8451                 monitor.write_for_disk(&mut w).unwrap();
8452                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8453                                 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
8454                 assert!(new_monitor == *monitor);
8455                 let watchtower = test_utils::TestChainMonitor::new(&chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator);
8456                 assert!(watchtower.watch_channel(outpoint, new_monitor).is_ok());
8457                 watchtower
8458         };
8459         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8460         watchtower_bob.chain_monitor.block_connected(&header, &vec![], 134);
8461
8462         // Route another payment to generate another update with still previous HTLC pending
8463         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
8464         {
8465                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8466                 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 , TEST_FINAL_CLTV, &logger).unwrap();
8467                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
8468         }
8469         check_added_monitors!(nodes[1], 1);
8470
8471         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8472         assert_eq!(updates.update_add_htlcs.len(), 1);
8473         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8474         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8475                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8476                         // Watchtower Alice should already have seen the block and reject the update
8477                         if let Err(_) =  watchtower_alice.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8478                         if let Ok(_) = watchtower_bob.chain_monitor.update_channel(outpoint, update.clone()) {} else { assert!(false); }
8479                         if let Ok(_) = nodes[0].chain_monitor.update_channel(outpoint, update) {} else { assert!(false); }
8480                 } else { assert!(false); }
8481         } else { assert!(false); };
8482         // Our local monitor is in-sync and hasn't processed yet timeout
8483         check_added_monitors!(nodes[0], 1);
8484
8485         //// Provide one more block to watchtower Bob, expect broadcast of commitment and HTLC-Timeout
8486         watchtower_bob.chain_monitor.block_connected(&header, &vec![], 135);
8487
8488         // Watchtower Bob should have broadcast a commitment/HTLC-timeout
8489         let bob_state_y;
8490         {
8491                 let mut txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8492                 assert_eq!(txn.len(), 2);
8493                 bob_state_y = txn[0].clone();
8494                 txn.clear();
8495         };
8496
8497         // We confirm Bob's state Y on Alice, she should broadcast a HTLC-timeout
8498         watchtower_alice.chain_monitor.block_connected(&header, &vec![(0, &bob_state_y)], 136);
8499         {
8500                 let htlc_txn = chanmon_cfgs[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8501                 // We broadcast twice the transaction, once due to the HTLC-timeout, once due
8502                 // the onchain detection of the HTLC output
8503                 assert_eq!(htlc_txn.len(), 2);
8504                 check_spends!(htlc_txn[0], bob_state_y);
8505                 check_spends!(htlc_txn[1], bob_state_y);
8506         }
8507 }